table

Documentation

Index

• type Cell
• type CellStyle
• type Row
• type Table
  • func NewTable() Table
  • func NewTableWithStyle(style *TableStyle) Table
• type TableStyle

Types

type Cell

type Cell struct {
	Content string

	// Prefix defines the prefix of the cell.
	Prefix string
	// PrefixFunc defines the prefix function of the cell.
	PrefixFunc func(isFirst, isLast bool) string

	// Suffix defines the suffix of the cell.
	Suffix string
	// SuffixFunc defines the suffix function of the cell.
	SuffixFunc func(isFirst, isLast bool) string
	// contains filtered or unexported fields
}

type CellStyle

type CellStyle struct {
	// Align defines the alignment of the text.
	Align text.Align

	// WrapText defines if the text should be wrapped.
	WrapText *bool

	// Markdown defines if the text should be rendered as markdown.
	Markdown *bool

	// TextAttrs defines the text attributes.
	TextAttrs text.Colors

	// CellAttrs defines the cell attributes.
	CellAttrs text.Colors
}

CellStyle is the style of a cell in the table

type Row

type Row []any

type Table

type Table interface {
	AddHeader(header ...string)
	AddRow(row Row)
	AddRows(rows []Row)

	Length() int

	SetStyle(style *TableStyle)
	SetHeaderStyle(style *CellStyle)
	SetRowStyle(row int, style *CellStyle)
	SetColStyle(col int, style *CellStyle)

	Render() string
}

func NewTable

func NewTable() Table

func NewTableWithStyle

func NewTableWithStyle(style *TableStyle) Table

type TableStyle

type TableStyle struct {
	// DefaultWidth defines the default width of the table.
	DefaultWidth int
	// FitToTerminal defines if the table should fit to the terminal width.
	FitToTerminal bool

	// WrapText defines if the text should be wrapped.
	WrapText bool
	// Markdown defines if the text should be rendered as markdown.
	Markdown bool
	// HideEmpty defines if empty rows should be hidden.
	HideEmpty bool

	// OuterPadding defines the padding around the table.
	OuterPadding int
	// InnerPadding defines the padding between the cells.
	InnerPadding int
}