list

Documentation

Index

• func AcceptChoices(accept bool) tea.Cmd
• func DefaultKeyMap() keys.KeyMap
• func VimKeyMap() keys.KeyMap
• type Component
  • func New() *Component
  • func (m *Component) AfterUpdate() tea.Cmd
  • func (m Component) CurrentItem() int
  • func (m *Component) DefaultKeyMap() *Component
  • func (m Component) GetCursor() int
  • func (m *Component) GotoBottom()
  • func (m *Component) GotoTop()
  • func (m Component) Height() int
  • func (m *Component) Init(props Props) tea.Cmd
  • func (m *Component) MoveDown(n int)
  • func (m *Component) MoveUp(n int)
  • func (m *Component) Render(w, h int) string
  • func (m *Component) SetCursor(n int)
  • func (m *Component) SetHeight(h int)
  • func (m *Component) SetKeyMap(km keys.KeyMap)
  • func (m *Component) SetWidth(w int)
  • func (m *Component) Update(msg tea.Msg) tea.Cmd
  • func (m *Component) UpdateItems()
  • func (m *Component) VimKeyMap() *Component
  • func (m Component) Width() int
• type Option
• type Props

Functions

func AcceptChoices

func AcceptChoices(accept bool) tea.Cmd

AcceptChoices returns a confirmation dialogue.

func DefaultKeyMap

func DefaultKeyMap() keys.KeyMap

func VimKeyMap

func VimKeyMap() keys.KeyMap

Types

type Component

type Component struct {
	reactea.BasicComponent
	reactea.BasicPropfulComponent[Props]

	Cursor int
	KeyMap keys.KeyMap

	Viewport viewport.Model
	// contains filtered or unexported fields
}

func New

func New() *Component

func (*Component) AfterUpdate

func (m *Component) AfterUpdate() tea.Cmd

func (Component) CurrentItem

func (m Component) CurrentItem() int

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

func (*Component) DefaultKeyMap

func (m *Component) DefaultKeyMap() *Component

func (Component) GetCursor

func (m Component) GetCursor() int

Cursor returns the index of the selected item.

func (*Component) GotoBottom

func (m *Component) GotoBottom()

GotoBottom moves the selection to the last row.

func (*Component) GotoTop

func (m *Component) GotoTop()

GotoTop moves the selection to the first row.

func (Component) Height

func (m Component) Height() int

Height returns the viewport height of the list.

func (*Component) Init

func (m *Component) Init(props Props) tea.Cmd

func (*Component) MoveDown

func (m *Component) MoveDown(n int)

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

func (*Component) MoveUp

func (m *Component) MoveUp(n int)

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

func (*Component) Render

func (m *Component) Render(w, h int) string

func (*Component) SetCursor

func (m *Component) SetCursor(n int)

SetCursor sets the cursor position in the list.

func (*Component) SetHeight

func (m *Component) SetHeight(h int)

SetHeight sets the height of the viewport of the list.

func (*Component) SetKeyMap

func (m *Component) SetKeyMap(km keys.KeyMap)

SetKeyMap sets the keymap for the list.

func (*Component) SetWidth

func (m *Component) SetWidth(w int)

SetWidth sets the width of the viewport of the list.

func (*Component) Update

func (m *Component) Update(msg tea.Msg) tea.Cmd

func (*Component) UpdateItems

func (m *Component) UpdateItems()

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

func (*Component) VimKeyMap

func (m *Component) VimKeyMap() *Component

func (Component) Width

func (m Component) Width() int

Width returns the viewport width of the list.

type Option

type Option func(*Component)

type Props

type Props struct {
	Editable    bool
	Filterable  bool
	Matches     []item.Item
	Selected    map[int]struct{}
	ToggleItems func(...int)
	ShowHelp    func([]map[string]string)
}