tmenu

README

tmenu

tmenu is tview based library that provides a main menu bar widget

To use tmenu follow these steps per cmd/main.go for example

1. Create the MenuItems that will be your menu bars main items
2. For each main item add sub MenuItems
3. Create the MenuBar
4. Add each main item to the menu bar in the desired order
5. Add the menu bar to the desired container, such as a flex - don't allow its size to be recomputed
6. Install the MenuBars AfterDraw() function as part of your AfterDraw routine, or as the main one to the application
7. Run the application

example

Documentation

Index

• type MenuBar
  • func NewMenuBar() *MenuBar
  • func (menuBar *MenuBar) AddItem(item *MenuItem) *MenuBar
  • func (menuBar *MenuBar) AfterDraw() func(tcell.Screen)
  • func (menuBar *MenuBar) Draw(screen tcell.Screen)
  • func (menuBar *MenuBar) Focus(delegate func(p tview.Primitive))
  • func (menuBar *MenuBar) InputHandler() func(event *tcell.EventKey, setFocus func(p tview.Primitive))
  • func (p *MenuBar) MouseHandler() ...
• type MenuItem
  • func NewMenuItem(title string) *MenuItem
  • func (menuItem *MenuItem) AddItem(item *MenuItem) *MenuItem
  • func (menuItem *MenuItem) Draw(screen tcell.Screen)
  • func (menuItem *MenuItem) SetOnClick(fn func(*MenuItem)) *MenuItem
• type SubMenu
  • func NewSubMenu(parent *MenuBar, items []*MenuItem) *SubMenu
  • func (subMenu *SubMenu) Draw(screen tcell.Screen)
  • func (subMenu *SubMenu) MouseHandler() ...

Types

type MenuBar

type MenuBar struct {
	*tview.Box
	MenuItems []*MenuItem
	// contains filtered or unexported fields
}

func NewMenuBar

func NewMenuBar() *MenuBar

func (*MenuBar) AddItem

func (menuBar *MenuBar) AddItem(item *MenuItem) *MenuBar

func (*MenuBar) AfterDraw

func (menuBar *MenuBar) AfterDraw() func(tcell.Screen)

func (*MenuBar) Draw

func (menuBar *MenuBar) Draw(screen tcell.Screen)

func (*MenuBar) Focus

func (menuBar *MenuBar) Focus(delegate func(p tview.Primitive))

func (*MenuBar) InputHandler

func (menuBar *MenuBar) InputHandler() func(event *tcell.EventKey, setFocus func(p tview.Primitive))

func (*MenuBar) MouseHandler

func (p *MenuBar) MouseHandler() func(action tview.MouseAction, event *tcell.EventMouse, setFocus func(p tview.Primitive)) (consumed bool, capture tview.Primitive)

type MenuItem

type MenuItem struct {
	*tview.Box
	Title    string
	SubItems []*MenuItem
	// contains filtered or unexported fields
}

func NewMenuItem

func NewMenuItem(title string) *MenuItem

func (*MenuItem) AddItem

func (menuItem *MenuItem) AddItem(item *MenuItem) *MenuItem

func (*MenuItem) Draw

func (menuItem *MenuItem) Draw(screen tcell.Screen)

func (*MenuItem) SetOnClick

func (menuItem *MenuItem) SetOnClick(fn func(*MenuItem)) *MenuItem

type SubMenu

type SubMenu struct {
	*tview.Box
	Items []*MenuItem
	// contains filtered or unexported fields
}

func NewSubMenu

func NewSubMenu(parent *MenuBar, items []*MenuItem) *SubMenu

func (*SubMenu) Draw

func (subMenu *SubMenu) Draw(screen tcell.Screen)

func (*SubMenu) MouseHandler

func (subMenu *SubMenu) MouseHandler() func(action tview.MouseAction, event *tcell.EventMouse, setFocus func(p tview.Primitive)) (consumed bool, capture tview.Primitive)