table

Documentation

Index

• func New(c *app.Ctx, props ...tableProp) *app.C
• func Table(c *app.Ctx, props app.Props) string
• func WithDataFunc(f func(c *app.Ctx) (clms []Column, rows []Row)) tableProp
• type Column
• type ColumnWidth
  • func WidthGrow() ColumnWidth
  • func WidthInt(i int) ColumnWidth
• type KeyMap
  • func (km KeyMap) FullHelp() [][]key.Binding
  • func (km KeyMap) ShortHelp() []key.Binding
• type Props
• type Row
• type Styles

Functions

func New

func New(c *app.Ctx, props ...tableProp) *app.C

NewTable creates a new table component instance.

func Table

func Table(c *app.Ctx, props app.Props) string

Table is the functional component for rendering a table.

func WithDataFunc

func WithDataFunc(f func(c *app.Ctx) (clms []Column, rows []Row)) tableProp

Types

type Column

type Column struct {
	Title string
	Width ColumnWidth
}

type ColumnWidth

type ColumnWidth struct {
	Int  int
	Grow bool
}

func WidthGrow

func WidthGrow() ColumnWidth

func WidthInt

func WidthInt(i int) ColumnWidth

type KeyMap

type KeyMap struct {
	LineUp       key.Binding
	LineDown     key.Binding
	PageUp       key.Binding
	PageDown     key.Binding
	HalfPageUp   key.Binding
	HalfPageDown key.Binding
	GotoTop      key.Binding
	GotoBottom   key.Binding
}

func (KeyMap) FullHelp

func (km KeyMap) FullHelp() [][]key.Binding

func (KeyMap) ShortHelp

func (km KeyMap) ShortHelp() []key.Binding

type Props

type Props struct {
	DataFunc func(c *app.Ctx) (clms []Column, rows []Row)
	KeyMap   KeyMap
	Styles   Styles
	Help     help.Model
	app.Margin
	app.Layout
}

Props holds the configuration for the Table component.

type Row

type Row []string

type Styles

type Styles struct {
	Base      lipgloss.Style
	BaseFocus lipgloss.Style
	Header    lipgloss.Style
	Cell      lipgloss.Style
	Selected  lipgloss.Style
	Hovered   lipgloss.Style // Currently unused
}