listbox

Documentation

Index

• type Item
• type ListModel
  • func New(maxVisible int) ListModel
  • func (m ListModel) Cursor() int
  • func (m ListModel) Init() tea.Cmd
  • func (m ListModel) Selected() Item
  • func (m *ListModel) SetItems(items []Item) tea.Cmd
  • func (m *ListModel) SetPointer(pointer string)
  • func (m ListModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m ListModel) View() string
• type SelectedMsg

Types

type Item

type Item interface {
	Display() string // what will be displayed
	ID() string      // unique identifier
}

Item is the minimal interface the list needs.

type ListModel

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

ListModel represents a scrollable list component

func New

func New(maxVisible int) ListModel

New creates a new ListModel with the specified maximum visible items

func (ListModel) Cursor

func (m ListModel) Cursor() int

Cursor returns the current cursor position

func (ListModel) Init

func (m ListModel) Init() tea.Cmd

Init initializes the model

func (ListModel) Selected

func (m ListModel) Selected() Item

Selected returns the currently selected item, or nil if there are no items

func (*ListModel) SetItems

func (m *ListModel) SetItems(items []Item) tea.Cmd

SetItems updates the items in the list

func (*ListModel) SetPointer

func (m *ListModel) SetPointer(pointer string)

SetPointer changes the pointer rune used to indicate selection

func (ListModel) Update

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

Update handles incoming messages and updates the model accordingly

func (ListModel) View

func (m ListModel) View() string

View renders the list

type SelectedMsg

type SelectedMsg struct {
	Item Item
}

SelectedMsg is emitted when an item is selected