README
¶
go-xlsx-templater
Simple .xlsx (Excel XML document) template based document generator using handlebars.
Takes input .xlsx documents with mustache sippets in it and renders new document with snippets replaced by provided context.
Thanks to github.com/tealeg/xlsx and github.com/aymerick/raymond for useful libs.
Installation
go get -u "github.com/ivahaev/go-xlsx-templater"
Usage
Import to your project
import "github.com/ivahaev/go-xlsx-templater"
Prepare template.xlsx template.
Filename may be any of course. For slices use dot notation {{items.name}}. When parser meets dot notation it will repeats contains row. If you need repeat few rows, or have nested slices, you can use range start {{range groups}} and {{end}}.
Prepare context data
ctx := map[string]interface{}{
"name": "Github User",
"groupHeader": "Group name",
"nameHeader": "Item name",
"quantityHeader": "Quantity",
"groups": []map[string]interface{}{
{
"name": "Work",
"total": 3,
"items": []map[string]interface{}{
{
"name": "Pen",
"quantity": 2,
},
{
"name": "Pencil",
"quantity": 1,
},
},
},
{
"name": "Weekend",
"total": 36,
"items": []map[string]interface{}{
{
"name": "Condom",
"quantity": 12,
},
{
"name": "Beer",
"quantity": 24,
},
},
},
},
}
Read template, render with context and save to disk.
Error processing omited in example.
doc := xlst.New()
doc.ReadTemplate("./template.xlsx")
doc.Render(ctx)
doc.Save("./report.xlsx")
Enjoy created report
Documentation
type Xlst
type Xlst struct {
// contains filtered or unexported fields
}
Xlst Represents template struct
func New
func New() *Xlst
New() creates new Xlst struct and returns pointer to it
func (*Xlst) ReadTemplate
func (m *Xlst) ReadTemplate(path string) error
ReadTemplate() reads template from disk and stores it in a struct
func (*Xlst) Render
func (m *Xlst) Render(ctx map[string]interface{}) error
Render() renders report and stores it in a struct
func (*Xlst) Save
func (m *Xlst) Save(path string) error
Save() saves generated report to disk
func (*Xlst) Write
func (m *Xlst) Write(writer io.Writer) error
Write() writes generated report to provided writer
Documentation
¶
Index ¶
- type Options
- type Xlst
- func (m *Xlst) OpenBinaryTemplate(content []byte) error
- func (m *Xlst) OpenFileTemplate(path string) error
- func (m *Xlst) OpenReaderAtTemplate(r io.ReaderAt, size int64) error
- func (m *Xlst) Render(in interface{}) error
- func (m *Xlst) RenderWithOptions(in interface{}, options *Options) error
- func (m *Xlst) Save(path string) error
- func (m *Xlst) Write(writer io.Writer) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
WrapTextInAllCells bool
}
Options for render has only one property WrapTextInAllCells for wrapping text
type Xlst ¶
type Xlst struct {
// contains filtered or unexported fields
}
Xlst Represents template struct
func (*Xlst) OpenBinaryTemplate ¶
OpenBinaryTemplate reads template from []byte and stores it in a struct
func (*Xlst) OpenFileTemplate ¶
ReadTemplate reads template from disk and stores it in a struct
func (*Xlst) OpenReaderAtTemplate ¶
ReadTemplate reads template from reader and stores it in a struct
func (*Xlst) RenderWithOptions ¶
RenderWithOptions renders report with options provided and stores it in a struct
Source Files
Directories