table

Documentation

Index

• type CellPosition
• type Column
• type KeyMap
  • func DefaultKeyMap() KeyMap
• type Model
  • func New(opts ...Option) Model
  • func (m *Model) Blur()
  • func (m *Model) ColIndex(n int) int
  • 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) MaxHScroll() int
  • func (m *Model) MoveDown(n int)
  • func (m *Model) MoveLeft(n int)
  • func (m *Model) MoveRight(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 WithFocused(f bool) Option
  • func WithHeight(h int) Option
  • func WithKeyMap(km KeyMap) Option
  • func WithRows(rows []Row) Option
  • func WithStyles(s Styles) Option
  • func WithWidth(w int) Option
• type Row
• type Styles
  • func DefaultStyles() Styles

Types

type CellPosition

type CellPosition struct {
	RowID         int
	Column        int
	IsRowSelected bool
}

CellPosition holds row and column indexes.

type Column

type Column struct {
	Title string
	Width int
}

Column defines the table structure.

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
	MoveLeft     key.Binding
	MoveRight    key.Binding
}

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

func DefaultKeyMap

func DefaultKeyMap() KeyMap

DefaultKeyMap returns a default set of keybindings.

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) ColIndex

func (m *Model) ColIndex(n int) int

ColIndex gets the index of a column n, where if n is positive it returns n clamped, and if n is negative it reutrns the column index counting from the right

func (Model) Cursor

func (m Model) Cursor() int

Cursor returns the index of the selected row.

func (*Model) Focus

func (m *Model) Focus()

Focus focusses 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) MaxHScroll

func (m *Model) MaxHScroll() int

Gets the maximum useful horizontal scroll

func (*Model) MoveDown

func (m *Model) MoveDown(n int)

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

func (*Model) MoveLeft

func (m *Model) MoveLeft(n int)

MoveLeft scrolls left

func (*Model) MoveRight

func (m *Model) MoveRight(n int)

MoveRight scrolls right

func (*Model) MoveUp

func (m *Model) MoveUp(n int)

MoveUp moves the selection up by any number of row. 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 set 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 set 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 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 WithRows

func WithRows(rows []Row) Option

WithRows sets the table rows (data).

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 Row

type Row []string

Row represents one line in the table.

type Styles

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

	// RenderCell is a low-level primitive for stylizing cells.
	// It is responsible for rendering the selection style. Styles.Cell is ignored.
	//
	// Example implementation:
	// s.RenderCell = func(model table.Model, value string, position table.CellPosition) string {
	// 	cellStyle := s.Cell.Copy()
	//
	// 	switch {
	// 	case position.IsRowSelected:
	// 		return cellStyle.Background(lipgloss.Color("57")).Render(value)
	// 	case position.Column == 1:
	// 		return cellStyle.Foreground(lipgloss.Color("21")).Render(value)
	// 	default:
	// 		return cellStyle.Render(value)
	// 	}
	// }
	RenderCell func(model Model, value string, position CellPosition) string
}

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.