tree

Documentation

Index

• type KeyMap
  • func DefaultKeyMap() KeyMap
• type Model
  • func New(nodes []Node) Model
  • func (m Model) Cursor() int
  • func (m Model) FullHelp() [][]key.Binding
  • func (m Model) GetNodeAtCurrentCursor() (Node, bool)
  • func (m *Model) NavDown()
  • func (m *Model) NavUp()
  • func (m Model) Nodes() []Node
  • func (m *Model) NumberOfNodes() int
  • func (m *Model) SetCursor(cursor int)
  • func (m *Model) SetNodes(nodes []Node)
  • func (m Model) ShortHelp() []key.Binding
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string
• type Node
• type Styles

Types

type KeyMap

type KeyMap struct {
	Bottom      key.Binding
	Top         key.Binding
	SectionDown key.Binding
	SectionUp   key.Binding
	Down        key.Binding
	Up          key.Binding
	Quit        key.Binding
}

KeyMap holds the key bindings for the table.

func DefaultKeyMap

func DefaultKeyMap() KeyMap

DefaultKeyMap is the default key bindings for the table.

type Model

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

func New

func New(nodes []Node) Model

func (Model) Cursor

func (m Model) Cursor() int

func (Model) FullHelp

func (m Model) FullHelp() [][]key.Binding

func (Model) GetNodeAtCurrentCursor

func (m Model) GetNodeAtCurrentCursor() (Node, bool)

GetNodeAtBFSIndex returns the node at a specific index in a breadth-first search traversal.

func (*Model) NavDown

func (m *Model) NavDown()

func (*Model) NavUp

func (m *Model) NavUp()

func (Model) Nodes

func (m Model) Nodes() []Node

func (*Model) NumberOfNodes

func (m *Model) NumberOfNodes() int

func (*Model) SetCursor

func (m *Model) SetCursor(cursor int)

func (*Model) SetNodes

func (m *Model) SetNodes(nodes []Node)

func (Model) ShortHelp

func (m Model) ShortHelp() []key.Binding

func (Model) Update

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

func (Model) View

func (m Model) View() string

type Node

type Node struct {
	Value    string
	Desc     string
	Children []Node
}

type Styles

type Styles struct {
	Shapes     lipgloss.Style
	Selected   lipgloss.Style
	Unselected lipgloss.Style
}