menu

Documentation

Index

• type Item
  • func (m Item) Text() string
• type Items
  • func NewItems(items ...Item) (mitems Items)
  • func (m Items) Len() int
  • func (m Items) Less(a, b int) bool
  • func (m Items) Swap(a, b int)
• type Menu
  • func NewMenu() *Menu
  • func (m *Menu) AddItems(items ...Item)
  • func (m *Menu) Buffer() ui.Buffer
  • func (m *Menu) ClearItems()
  • func (m *Menu) DelItem(s string) (success bool)
  • func (m *Menu) Down()
  • func (m *Menu) SelectedItem() Item
  • func (m *Menu) SelectedValue() string
  • func (m *Menu) SetCursor(s string) (success bool)
  • func (m *Menu) SetToolTip(lines ...string)
  • func (m *Menu) Up()
• type Padding
• type ToolTip
  • func NewToolTip(lines ...string) *ToolTip
  • func (t *ToolTip) Align()
  • func (t *ToolTip) Buffer() ui.Buffer

Types

type Item

type Item struct {
	Val   string
	Label string
}

func (Item) Text

func (m Item) Text() string

Use label as display text of item, if given

type Items

type Items []Item

func NewItems

func NewItems(items ...Item) (mitems Items)

func (Items) Len

func (m Items) Len() int

Sort methods for Items

func (Items) Less

func (m Items) Less(a, b int) bool

func (Items) Swap

func (m Items) Swap(a, b int)

type Menu

type Menu struct {
	ui.Block
	SortItems   bool   // enable automatic sorting of menu items
	Selectable  bool   // whether menu is navigable
	SubText     string // optional text to display before items
	TextFgColor ui.Attribute
	TextBgColor ui.Attribute
	// contains filtered or unexported fields
}

func NewMenu

func NewMenu() *Menu

func (*Menu) AddItems

func (m *Menu) AddItems(items ...Item)

Append Item to Menu

func (*Menu) Buffer

func (m *Menu) Buffer() ui.Buffer

func (*Menu) ClearItems

func (m *Menu) ClearItems()

ClearItems removes all current menu items

func (*Menu) DelItem

func (m *Menu) DelItem(s string) (success bool)

DelItem removes menu item by value or label

func (*Menu) Down

func (m *Menu) Down()

func (*Menu) SelectedItem

func (m *Menu) SelectedItem() Item

func (*Menu) SelectedValue

func (m *Menu) SelectedValue() string

func (*Menu) SetCursor

func (m *Menu) SetCursor(s string) (success bool)

Move cursor to an position by Item value or label

func (*Menu) SetToolTip

func (m *Menu) SetToolTip(lines ...string)

SetToolTip sets an optional tooltip string to show at bottom of screen

func (*Menu) Up

func (m *Menu) Up()

type Padding

type Padding [2]int // x,y padding

type ToolTip

type ToolTip struct {
	ui.Block
	Lines       []string
	TextFgColor ui.Attribute
	TextBgColor ui.Attribute
	// contains filtered or unexported fields
}

func NewToolTip

func NewToolTip(lines ...string) *ToolTip

func (*ToolTip) Align

func (t *ToolTip) Align()

Set width and height based on screen size

func (*ToolTip) Buffer

func (t *ToolTip) Buffer() ui.Buffer