editable

Documentation

Index

• type Cell
• type Column
• type KeyMap
  • func DefaultKeyMap() KeyMap
• type Model
  • func NewModel(opts ...Option) Model
  • func (m *Model) AddRow()
  • func (m Model) At(row, column int) string
  • func (m *Model) Blur()
  • func (m Model) Columns() int
  • func (m Model) Cursor() (int, int)
  • func (m Model) Errors() []error
  • func (m *Model) Focus()
  • func (m *Model) GotoBottom() tea.Cmd
  • func (m *Model) GotoTop() tea.Cmd
  • func (m Model) Init() tea.Cmd
  • func (m *Model) Move(y, x int) tea.Cmd
  • func (m *Model) MoveDown(n int) tea.Cmd
  • func (m *Model) MoveLeft(n int) tea.Cmd
  • func (m *Model) MoveRight(n int) tea.Cmd
  • func (m *Model) MoveToNextCell() tea.Cmd
  • func (m *Model) MoveUp(n int) tea.Cmd
  • func (m *Model) RemoveRow(n int)
  • func (m Model) Rows() int
  • func (m *Model) SetColumns(c []Column)
  • func (m *Model) SetStyles(s Styles)
  • func (m Model) Titles() []string
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) Validate()
  • func (m Model) Values() [][]string
  • func (m Model) View() string
• type Option
  • func IsOptional(optional bool) Option
  • func WithColumns(columns []Column) Option
  • func WithKeyMap(km KeyMap) Option
  • func WithRows(rows []Row) Option
  • func WithStyles(s Styles) Option
• type Row
• type Styles
  • func DefaultStyles() Styles

Types

type Cell

type Cell struct {
	// contains filtered or unexported fields
}

type Column

type Column struct {
	Title      string
	Width      int
	Validators []func([]string, [][]string, string) error
}

type KeyMap

type KeyMap struct {
	CellUp     key.Binding
	CellDown   key.Binding
	CellLeft   key.Binding
	CellRight  key.Binding
	NextCell   key.Binding
	NewRow     key.Binding
	PageUp     key.Binding
	PageDown   key.Binding
	GotoTop    key.Binding
	GotoBottom key.Binding
}

func DefaultKeyMap

func DefaultKeyMap() KeyMap

type Model

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

func NewModel

func NewModel(opts ...Option) Model

func (*Model) AddRow

func (m *Model) AddRow()

func (Model) At

func (m Model) At(row, column int) string

func (*Model) Blur

func (m *Model) Blur()

func (Model) Columns

func (m Model) Columns() int

func (Model) Cursor

func (m Model) Cursor() (int, int)

func (Model) Errors

func (m Model) Errors() []error

func (*Model) Focus

func (m *Model) Focus()

func (*Model) GotoBottom

func (m *Model) GotoBottom() tea.Cmd

func (*Model) GotoTop

func (m *Model) GotoTop() tea.Cmd

func (Model) Init

func (m Model) Init() tea.Cmd

func (*Model) Move

func (m *Model) Move(y, x int) tea.Cmd

func (*Model) MoveDown

func (m *Model) MoveDown(n int) tea.Cmd

func (*Model) MoveLeft

func (m *Model) MoveLeft(n int) tea.Cmd

func (*Model) MoveRight

func (m *Model) MoveRight(n int) tea.Cmd

func (*Model) MoveToNextCell

func (m *Model) MoveToNextCell() tea.Cmd

func (*Model) MoveUp

func (m *Model) MoveUp(n int) tea.Cmd

func (*Model) RemoveRow

func (m *Model) RemoveRow(n int)

func (Model) Rows

func (m Model) Rows() int

func (*Model) SetColumns

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

func (*Model) SetStyles

func (m *Model) SetStyles(s Styles)

func (Model) Titles

func (m Model) Titles() []string

func (Model) Update

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

func (*Model) Validate

func (m *Model) Validate()

func (Model) Values

func (m Model) Values() [][]string

func (Model) View

func (m Model) View() string

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 IsOptional

func IsOptional(optional bool) Option

func WithColumns

func WithColumns(columns []Column) Option

func WithKeyMap

func WithKeyMap(km KeyMap) Option

func WithRows

func WithRows(rows []Row) Option

func WithStyles

func WithStyles(s Styles) Option

type Row

type Row []Cell

type Styles

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

func DefaultStyles

func DefaultStyles() Styles