Exceltag

Introduction

This package allows you to generate a simple Excel file from an array of structs by adding the tag excel:"your header".

Furthermore, fields without the excel tag will be ignored, allowing you to exclude specific fields from export.

Built on top of the qax-os/excelize package.

Installation

go get github.com/noahchiu22/exceltag

Generate a simple excel file with tags in your struct

type studentInfo struct {
	Num   int64  `excel:"student number"`
	Name  string `excel:"student name"`
	UpdatedAt time.Time `excel:"updated time"`
	// other field without excel tag if you don't want to export to excel
	other string
}

func main() {
	students := []studentInfo{
		{Num: 1, Name: "John", UpdatedAt: time.Now(), other: "other"},
		{Num: 2, Name: "Jane", UpdatedAt: time.Now(), other: "other"},
		{Num: 3, Name: "Jim", UpdatedAt: time.Now(), other: "other"},
		{Num: 4, Name: "Jill", UpdatedAt: time.Now(), other: "other"},
		{Num: 5, Name: "Jack", UpdatedAt: time.Now(), other: "other"},
		{Num: 6, Name: "Jill", UpdatedAt: time.Now(), other: "other"},
	}
	// generate excel file
	f, err := exceltag.CreateExcel(students)
	if err != nil {
		fmt.Println("err", err)
		return
	}

	// you can add some change or style to your excel file...

	// Save spreadsheet by the given path.
	if err := f.SaveAs("studentInfo.xlsx"); err != nil {
		fmt.Println("err", err)
		return
	}
}

and the simple spreadsheet of student data will be generated as follows:

Customizing the Excel File with excelize

Using the excelize's functions to customize the excel file, like changing the sheet name, column width, and row color.

You can change the sheet name by using the excelize's SetSheetName function:

err := f.SetSheetName("Sheet1", "Student Info")
if err != nil {
	fmt.Println("err", err)
	return
}

also, you can change the column width by using the excelize's SetColWidth function:

err = f.SetColWidth("Sheet1", "A", "B", 20)
if err != nil {
	fmt.Println("err", err)
	return
}

and row color by using the excelize's SetRowStyle function:

styleID, err := f.NewStyle(&excelize.Style{
	Fill: excelize.Fill{
		Type:    "pattern",
		Color:   []string{"#C0DCF4"},
		Pattern: 1,
	},
})
if err != nil {	
	fmt.Println("err", err)
	return
}

err = f.SetRowStyle("Sheet1", 1, 1, styleID)
if err != nil {
	fmt.Println("err", err)
	return
}

Autofit column width

The function AutofitColumn will automatically fit the column width by the cell content, you can use the AutofitColumn function to do this.

err := exceltag.AutofitColumn(f, "Sheet1")
if err != nil {
	fmt.Println("err", err)
	return
}

Resource

qax-os/excelize