Skip to content
/ maroto Public
forked from johnfercher/maroto

A fork of maroto package, which is a maroto way PDF generator, to support the Chinese line wrap.

License

Notifications You must be signed in to change notification settings

tracmo/maroto

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maroto

GoDoc Travis Codecov Go Report Card Mentioned in Awesome Go

A Maroto way to create PDFs. Maroto is inspired in Bootstrap and uses Gofpdf. Fast and simple.

Maroto definition: Brazilian expression, means an astute/clever/intelligent person.

You can write your PDFs like you are creating a site using Bootstrap. A Row may have many Cols, and a Col may have many components. Besides that, pages will be added when content may extrapolate the useful area. You can define a header which will be added always when a new page appear, in this case, a header may have many rows, lines or tablelist.

Installation

  • With go get:
go get -u github.com/tracmo/maroto

Contributing

Command Description Dependencies
make fmt Format files gofmt, gofumpt and goimports
make lint Check files golangci-lint and goreportcard-cli
make dod (Definition of Done) Format files and check files Same as make fmt and make lint
make install Install all dependencies go, curl and git
make examples Run all examples go

Features

result

Constructors

Grid System

Components To Use Inside a Col

Components To Use Outside a Row

Components To Wrap Row, TableList and Line

Saving PDF

Fonts

  • AddUTF8Font: Add a custom utf8 font and allow any character of any language.
  • SetDefaultFontFamily: Define a default font family, useful to use with a custom font.
  • SetFontLocation: Define the default path to search the custom font
  • 100% Unicode

Page

  • AddPage: Skip the current page and start the build a new one
  • SetPageMargins: Customize the page margins
  • SetAliasNbPages: Set placeholder to use in texts for total count of pages
  • SetFirstPageNb: Set first number for page numbering
  • Automatic New Page: New pages are generated automatically when needed.

Customizations

  • Properties: most of the components has properties which you can use to customize appearance and behavior
  • SetBorder: Used to draw rectangles in every row and column
  • SetBackgroundColor: Used to change the background color of one cell

Roadmap

Examples

In the PDFs folder there are the PDFs generated using Maroto, and in the examples folder there are subfolders with the code to generate the PDFs. There are examples of: barcode, billing, certificate, custom pdf size, image inside grid, qrcode inside grid, sample with almost all features together, text inside grid, custom utf8 fonts (any language) and a label zpl.

result

Other Examples

Title Media
How to create PDFs with Go, Maroto & GoFakeIt Video
Creating a PDF with Go, Maroto & Gofakeit Article
divrhino/fruitful-pdf Repository
Creating PDFs using Golang Article

Code

This is part of the example billing.

// Billing example
package main

import (
 "fmt"
 "github.com/tracmo/maroto/pkg/color"
 "github.com/tracmo/maroto/pkg/consts"
 "github.com/tracmo/maroto/pkg/pdf"
 "github.com/tracmo/maroto/pkg/props"
 "os"
 "time"
)

func main() {
 begin := time.Now()

 darkGrayColor := getDarkGrayColor()
 grayColor := getGrayColor()
 whiteColor := color.NewWhite()
 header := getHeader()
 contents := getContents()

 m := pdf.NewMaroto(consts.Portrait, consts.A4)
 m.SetPageMargins(10, 15, 10)
 //m.SetBorder(true)

 m.RegisterHeader(func() {
  m.Row(20, func() {
   m.Col(3, func() {
    _ = m.FileImage("internal/assets/images/biplane.jpg", props.Rect{
     Center:  true,
     Percent: 80,
    })
   })

   m.ColSpace(6)

   m.Col(3, func() {
    m.Text("AnyCompany Name Inc. 851 Any Street Name, Suite 120, Any City, CA 45123.", props.Text{
     Size:        8,
     Align:       consts.Right,
     Extrapolate: false,
    })
    m.Text("Tel: 55 024 12345-1234", props.Text{
     Top:   12,
     Style: consts.BoldItalic,
     Size:  8,
     Align: consts.Right,
    })
    m.Text("www.mycompany.com", props.Text{
     Top:   15,
     Style: consts.BoldItalic,
     Size:  8,
     Align: consts.Right,
    })
   })
  })
 })

 m.RegisterFooter(func() {
  m.Row(20, func() {
   m.Col(12, func() {
    m.Text("Tel: 55 024 12345-1234", props.Text{
     Top:   13,
     Style: consts.BoldItalic,
     Size:  8,
     Align: consts.Left,
    })
    m.Text("www.mycompany.com", props.Text{
     Top:   16,
     Style: consts.BoldItalic,
     Size:  8,
     Align: consts.Left,
    })
   })
  })
 })

 m.Row(10, func() {
  m.Col(12, func() {
   m.Text("Invoice ABC123456789", props.Text{
    Top:   3,
    Style: consts.Bold,
    Align: consts.Center,
   })
  })
 })

 m.SetBackgroundColor(darkGrayColor)

 m.Row(7, func() {
  m.Col(3, func() {
   m.Text("Transactions", props.Text{
    Top:   1.5,
    Size:  9,
    Style: consts.Bold,
    Align: consts.Center,
   })
  })
  m.ColSpace(9)
 })

 m.SetBackgroundColor(whiteColor)

 m.TableList(header, contents, props.TableList{
  HeaderProp: props.TableListContent{
   Size:      9,
   GridSizes: []uint{3, 4, 2, 3},
  },
  ContentProp: props.TableListContent{
   Size:      8,
   GridSizes: []uint{3, 4, 2, 3},
  },
  Align:                consts.Center,
  AlternatedBackground: &grayColor,
  HeaderContentSpace:   1,
  Line:                 false,
 })

 m.Row(20, func() {
  m.ColSpace(7)
  m.Col(2, func() {
   m.Text("Total:", props.Text{
    Top:   5,
    Style: consts.Bold,
    Size:  8,
    Align: consts.Right,
   })
  })
  m.Col(3, func() {
   m.Text("R$ 2.567,00", props.Text{
    Top:   5,
    Style: consts.Bold,
    Size:  8,
    Align: consts.Center,
   })
  })
 })

 m.Row(15, func() {
  m.Col(6, func() {
   _ = m.Barcode("5123.151231.512314.1251251.123215", props.Barcode{
    Percent: 0,
    Proportion: props.Proportion{
     Width:  20,
     Height: 2,
    },
   })
   m.Text("5123.151231.512314.1251251.123215", props.Text{
    Top:    12,
    Family: "",
    Style:  consts.Bold,
    Size:   9,
    Align:  consts.Center,
   })
  })
  m.ColSpace(6)
 })

 err := m.OutputFileAndClose("internal/examples/pdfs/billing.pdf")
 if err != nil {
  fmt.Println("Could not save PDF:", err)
  os.Exit(1)
 }

 end := time.Now()
 fmt.Println(end.Sub(begin))
}

Stargazers over time

Stargazers over time

Under the Fork

We forked the repository from johnfercher/maroto with the tag v0.38.0.

We updated the maroto package with the following features/enhancements:

  • Support auto line wrap with Chinese for the Text component.
  • Add the left, right, and bottom margins to the text properties of the Text component.
  • Add new helper function, CalcTextHeight, to estimate the height of multiple text lines of Text component.
  • Support configable MaxGridSum, which default is 12, and add 2 helper functions, SetMaxGridSum and GetMaxGridSum.
  • Fix the issue of the floating position of page footer.

About

A fork of maroto package, which is a maroto way PDF generator, to support the Chinese line wrap.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 99.4%
  • Other 0.6%