components

Documentation

Index

• type ListComponent
  • func NewListComponent(config *ListComponentConfig) *ListComponent
  • func (c *ListComponent) Init() tea.Cmd
  • func (c *ListComponent) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (c *ListComponent) View() string
• type ListComponentConfig
• type ListItem
  • func (i *ListItem) Description() string
  • func (i *ListItem) FilterValue() string
  • func (i *ListItem) Title() string
• type OnSelectFunc

Types

type ListComponent

type ListComponent struct {
	Model list.Model
	Style lipgloss.Style
}

func NewListComponent

func NewListComponent(config *ListComponentConfig) *ListComponent

func (*ListComponent) Init

func (c *ListComponent) Init() tea.Cmd

func (*ListComponent) Update

func (c *ListComponent) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*ListComponent) View

func (c *ListComponent) View() string

type ListComponentConfig

type ListComponentConfig struct {
	Items               []*ListItem
	DefaultSearchFilter string
	OnSelect            OnSelectFunc
}

type ListItem

type ListItem struct {
	ID any

	Name    string
	Details string
}

func (*ListItem) Description

func (i *ListItem) Description() string

func (*ListItem) FilterValue

func (i *ListItem) FilterValue() string

func (*ListItem) Title

func (i *ListItem) Title() string

type OnSelectFunc

type OnSelectFunc func(*ListItem)