table

Documentation

Index

• type Column
• type DeleteFn
• type KeyMap
  • func DefaultKeyMap() KeyMap
  • func (km KeyMap) FullHelp() [][]key.Binding
  • func (km KeyMap) ShortHelp() []key.Binding
• type Model
  • func New(opts ...Option) Model
  • func (m *Model) Blur()
  • func (m Model) Columns() []Column
  • func (m Model) Cursor() int
  • func (m *Model) Focus()
  • func (m Model) Focused() bool
  • func (m *Model) FromValues(value, separator string)
  • func (m *Model) GotoBottom()
  • func (m *Model) GotoTop()
  • func (m Model) Height() int
  • func (m *Model) Mark()
  • func (m *Model) MoveDown(n int)
  • func (m *Model) MoveUp(n int)
  • func (m Model) Rows() []Row
  • func (m Model) SelectedRow() Row
  • func (m *Model) SetColumns(c []Column)
  • func (m *Model) SetCursor(n int)
  • func (m *Model) SetHeight(h int)
  • func (m *Model) SetRows(r []Row)
  • func (m *Model) SetStyles(s Styles)
  • func (m *Model) SetWidth(w int)
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m *Model) UpdateViewport()
  • func (m Model) View() string
  • func (m Model) Width() int
• type Option
  • func WithColumns(cols []Column) Option
  • func WithDeleteFn(d DeleteFn) Option
  • func WithFocused(f bool) Option
  • func WithHeight(h int) Option
  • func WithKeyMap(km KeyMap) Option
  • func WithRefreshFn(r RefreshFn) Option
  • func WithRows(rows []Row) Option
  • func WithStyleFunc(f StyleFunc) Option
  • func WithStyles(s Styles) Option
  • func WithWidth(w int) Option
• type RefreshFn
• type Row
• type StyleFunc
• type Styles
  • func DefaultStyles() Styles

Types

type Column

type Column struct {
	Title string
	Width int
}

Column defines the table structure.

type DeleteFn

type DeleteFn func(rows []Row) error

DeleteFn is a function that deletes rows.

type KeyMap

type KeyMap struct {
	LineUp     key.Binding
	LineDown   key.Binding
	PageUp     key.Binding
	PageDown   key.Binding
	GotoTop    key.Binding
	GotoBottom key.Binding
	Mark       key.Binding
	Execute    key.Binding
	Expand     key.Binding
}

KeyMap defines keybindings. It satisfies to the help.KeyMap interface, which is used to render the menu.

func DefaultKeyMap

func DefaultKeyMap() KeyMap

DefaultKeyMap returns a default set of keybindings.

func (KeyMap) FullHelp

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

FullHelp implements the KeyMap interface.

func (KeyMap) ShortHelp

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

ShortHelp implements the KeyMap interface.

type Model

type Model struct {
	KeyMap KeyMap
	// contains filtered or unexported fields
}

Model defines a state for the table widget.

func New

func New(opts ...Option) Model

New creates a new model for the table widget.

func (*Model) Blur

func (m *Model) Blur()

Blur blurs the table, preventing selection or movement.

func (Model) Columns

func (m Model) Columns() []Column

Columns returns the current columns.

func (Model) Cursor

func (m Model) Cursor() int

Cursor returns the index of the selected row.

func (*Model) Focus

func (m *Model) Focus()

Focus focuses the table, allowing the user to move around the rows and interact.

func (Model) Focused

func (m Model) Focused() bool

Focused returns the focus state of the table.

func (*Model) FromValues

func (m *Model) FromValues(value, separator string)

FromValues create the table rows from a simple string. It uses `\n` by default for getting all the rows and the given separator for the fields on each row.

func (*Model) GotoBottom

func (m *Model) GotoBottom()

GotoBottom moves the selection to the last row.

func (*Model) GotoTop

func (m *Model) GotoTop()

GotoTop moves the selection to the first row.

func (Model) Height

func (m Model) Height() int

Height returns the viewport height of the table.

func (*Model) Mark

func (m *Model) Mark()

Mark the current cursor position to indicate that the underlying document will be deleted.

func (*Model) MoveDown

func (m *Model) MoveDown(n int)

MoveDown moves the selection down by any number of rows. It can not go below the last row.

func (*Model) MoveUp

func (m *Model) MoveUp(n int)

MoveUp moves the selection up by any number of rows. It can not go above the first row.

func (Model) Rows

func (m Model) Rows() []Row

Rows returns the current rows.

func (Model) SelectedRow

func (m Model) SelectedRow() Row

SelectedRow returns the selected row. You can cast it to your own implementation.

func (*Model) SetColumns

func (m *Model) SetColumns(c []Column)

SetColumns sets a new columns state.

func (*Model) SetCursor

func (m *Model) SetCursor(n int)

SetCursor sets the cursor position in the table.

func (*Model) SetHeight

func (m *Model) SetHeight(h int)

SetHeight sets the height of the viewport of the table.

func (*Model) SetRows

func (m *Model) SetRows(r []Row)

SetRows sets a new rows state.

func (*Model) SetStyles

func (m *Model) SetStyles(s Styles)

SetStyles sets the table styles.

func (*Model) SetWidth

func (m *Model) SetWidth(w int)

SetWidth sets the width of the viewport of the table.

func (Model) Update

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

Update is the Bubble Tea update loop.

func (*Model) UpdateViewport

func (m *Model) UpdateViewport()

UpdateViewport updates the list content based on the previously defined columns and rows.

func (Model) View

func (m Model) View() string

View renders the component.

func (Model) Width

func (m Model) Width() int

Width returns the viewport width of the table.

type Option

type Option func(*Model)

Option is used to set options in New. For example:

table := New(WithColumns([]Column{{Title: "ID", Width: 10}}))

func WithColumns

func WithColumns(cols []Column) Option

WithColumns sets the table columns (headers).

func WithDeleteFn

func WithDeleteFn(d DeleteFn) Option

WithDeleteFn sets the deletion callback.

func WithFocused

func WithFocused(f bool) Option

WithFocused sets the focus state of the table.

func WithHeight

func WithHeight(h int) Option

WithHeight sets the height of the table.

func WithKeyMap

func WithKeyMap(km KeyMap) Option

WithKeyMap sets the key map.

func WithRefreshFn

func WithRefreshFn(r RefreshFn) Option

WithRefreshFn sets the refresh callback.

func WithRows

func WithRows(rows []Row) Option

WithRows sets the table rows (data).

func WithStyleFunc

func WithStyleFunc(f StyleFunc) Option

WithStyleFunc sets the table style func which can determine a cell style per column, row, and selected state.

func WithStyles

func WithStyles(s Styles) Option

WithStyles sets the table styles.

func WithWidth

func WithWidth(w int) Option

WithWidth sets the width of the table.

type RefreshFn

type RefreshFn func() []Row

RefreshFn is a function that refreshes the available rows.

type Row

type Row []string

Row represents one line in the table.

type StyleFunc

type StyleFunc func(row, col int, value string) lipgloss.Style

StyleFunc is a function that can be used to customize the style of a table cell based on the row and column index.

type Styles

type Styles struct {
	Header   lipgloss.Style
	Cell     lipgloss.Style
	Selected lipgloss.Style
	Marked   lipgloss.Style
}

Styles contains style definitions for this list component. By default, these values are generated by DefaultStyles.

func DefaultStyles

func DefaultStyles() Styles

DefaultStyles returns a set of default style definitions for this table.