tui

Documentation

Index

• Variables
• func ListBranches(branches []*git.Branch) error
• type Item
  • func ItemsFromBranches(branches []*git.Branch) ([]*Item, error)
  • func NewItemFromBranch(branch *git.Branch) (*Item, error)
  • func RunMultiSelect(items []*Item) ([]*Item, error)
  • func RunSingleSelect(items []*Item) (*Item, error)
• type MultiSelectKeyMap
  • func (k MultiSelectKeyMap) FullHelp() [][]key.Binding
  • func (k MultiSelectKeyMap) ShortHelp() []key.Binding
• type MultiSelectModel
  • func NewMultiSelectModel(items []*Item) *MultiSelectModel
  • func (m *MultiSelectModel) Error() error
  • func (m *MultiSelectModel) Init() tea.Cmd
  • func (m *MultiSelectModel) SelectedItems() []*Item
  • func (m *MultiSelectModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *MultiSelectModel) View() string
• type RenderItemFunc
• type SelectModel
  • func NewSingleSelectModel(items []*Item) *SelectModel
  • func (m *SelectModel) Error() error
  • func (m *SelectModel) Init() tea.Cmd
  • func (m *SelectModel) SelectedItem() *Item
  • func (m *SelectModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *SelectModel) View() string
• type SingleSelectKeyMap
  • func (k SingleSelectKeyMap) FullHelp() [][]key.Binding
  • func (k SingleSelectKeyMap) ShortHelp() []key.Binding

Variables

var DefaultMultiSelectKeyMap = MultiSelectKeyMap{
	Prev: key.NewBinding(
		key.WithKeys("up", "k"),
		key.WithHelp("↑/k", "move up"),
	),
	Next: key.NewBinding(
		key.WithKeys("down", "j", "tab"),
		key.WithHelp("↓/j/tab", "move down"),
	),
	Select: key.NewBinding(
		key.WithKeys(" "),
		key.WithHelp("space", "select"),
	),
	Confirm: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "confirm"),
	),
	Help: key.NewBinding(
		key.WithKeys("?"),
		key.WithHelp("?", "toggle help"),
	),
	Quit: key.NewBinding(
		key.WithKeys("q", "esc", "ctrl+c"),
		key.WithHelp("q", "quit"),
	),
}

var DefaultSingleSelectKeyMap = SingleSelectKeyMap{
	Prev: key.NewBinding(
		key.WithKeys("up", "k"),
		key.WithHelp("↑/k", "move up"),
	),
	Next: key.NewBinding(
		key.WithKeys("down", "j", "tab"),
		key.WithHelp("↓/j/tab", "move down"),
	),
	Confirm: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "confirm"),
	),
	Help: key.NewBinding(
		key.WithKeys("?"),
		key.WithHelp("?", "toggle help"),
	),
	Quit: key.NewBinding(
		key.WithKeys("q", "esc", "ctrl+c"),
		key.WithHelp("q", "quit"),
	),
}

var (
	ErrQuit = errors.New("user exited prompt")
)

Functions

func ListBranches

func ListBranches(branches []*git.Branch) error

Types

type Item

type Item struct {
	Name     string
	Note     string
	Selected bool
}

func ItemsFromBranches

func ItemsFromBranches(branches []*git.Branch) ([]*Item, error)

func NewItemFromBranch

func NewItemFromBranch(branch *git.Branch) (*Item, error)

func RunMultiSelect

func RunMultiSelect(items []*Item) ([]*Item, error)

func RunSingleSelect

func RunSingleSelect(items []*Item) (*Item, error)

type MultiSelectKeyMap

type MultiSelectKeyMap struct {
	Prev    key.Binding
	Next    key.Binding
	Select  key.Binding
	Confirm key.Binding
	Help    key.Binding
	Quit    key.Binding
}

func (MultiSelectKeyMap) FullHelp

func (k MultiSelectKeyMap) FullHelp() [][]key.Binding

func (MultiSelectKeyMap) ShortHelp

func (k MultiSelectKeyMap) ShortHelp() []key.Binding

type MultiSelectModel

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

func NewMultiSelectModel

func NewMultiSelectModel(items []*Item) *MultiSelectModel

func (*MultiSelectModel) Error

func (m *MultiSelectModel) Error() error

func (*MultiSelectModel) Init

func (m *MultiSelectModel) Init() tea.Cmd

func (*MultiSelectModel) SelectedItems

func (m *MultiSelectModel) SelectedItems() []*Item

func (*MultiSelectModel) Update

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

func (*MultiSelectModel) View

func (m *MultiSelectModel) View() string

type RenderItemFunc

type RenderItemFunc func(item *Item, hovered bool) string

type SelectModel

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

func NewSingleSelectModel

func NewSingleSelectModel(items []*Item) *SelectModel

func (*SelectModel) Error

func (m *SelectModel) Error() error

func (*SelectModel) Init

func (m *SelectModel) Init() tea.Cmd

func (*SelectModel) SelectedItem

func (m *SelectModel) SelectedItem() *Item

func (*SelectModel) Update

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

func (*SelectModel) View

func (m *SelectModel) View() string

type SingleSelectKeyMap

type SingleSelectKeyMap struct {
	Prev    key.Binding
	Next    key.Binding
	Confirm key.Binding
	Help    key.Binding
	Quit    key.Binding
}

func (SingleSelectKeyMap) FullHelp

func (k SingleSelectKeyMap) FullHelp() [][]key.Binding

func (SingleSelectKeyMap) ShortHelp

func (k SingleSelectKeyMap) ShortHelp() []key.Binding