table

Documentation

Index

• type Column
  • func NewColumn(header string) Column
  • func (c Column) WithLeftAlign() Column
• type Row
• type Table
  • func NewTable(cols []Column, data []Row) Table
  • func (t *Table) Render(w io.Writer)

Types

type Column

type Column struct {
	Header string
	Width  int
	// If false, render this column.
	Hide bool
	// If true, set the width to the widest value in this column.
	Flexible  bool
	LeftAlign bool
}

Column represents metadata about a column in a table.

func NewColumn

func NewColumn(header string) Column

NewColumn creates a new flexible column with the given name.

func (Column) WithLeftAlign

func (c Column) WithLeftAlign() Column

WithLeftAlign turns on the left align of this column and returns it.

type Row

type Row = []string

Row is a single row of data in a table.

type Table

type Table struct {
	Columns       []Column
	Data          []Row
	Sort          []int
	ColumnSpacing string
}

Table represents a table of data to be rendered.

func NewTable

func NewTable(cols []Column, data []Row) Table

NewTable creates a new table with the given columns and rows.

func (*Table) Render

func (t *Table) Render(w io.Writer)

Render writes the full table to the given Writer.