TermUI.Widgets.Menu (TermUI v0.2.0)

Menu widget for displaying hierarchical actions.

Menu displays a list of items that can be actions, submenus, separators, or checkboxes. Supports keyboard navigation and shortcut display.

Usage

Menu.new(
  items: [
    Menu.action(:new, "New File", shortcut: "Ctrl+N"),
    Menu.action(:open, "Open...", shortcut: "Ctrl+O"),
    Menu.separator(),
    Menu.submenu(:recent, "Recent Files", [
      Menu.action(:file1, "document.txt"),
      Menu.action(:file2, "notes.md")
    ]),
    Menu.separator(),
    Menu.checkbox(:autosave, "Auto Save", checked: true),
    Menu.action(:exit, "Exit", shortcut: "Ctrl+Q")
  ],
  on_select: fn id -> handle_menu_action(id) end
)

Item Types

:action - Selectable menu item
:submenu - Item with nested menu items
:separator - Visual divider
:checkbox - Toggleable item with check state

Keyboard Navigation

Up/Down: Move between items
Enter/Space: Select item or expand submenu
Left: Collapse submenu
Right: Expand submenu
Escape: Close menu

Summary

Types

item_type()

Functions

action(id, label, opts \\ [])

Creates an action menu item.

checkbox(id, label, opts \\ [])

Creates a checkbox item.

checked?(state, item_id)

Gets checkbox state.

collapse(state, submenu_id)

Collapses a submenu by ID.

expand(state, submenu_id)

Expands a submenu by ID.

expanded?(state, submenu_id)

Checks if a submenu is expanded.

get_cursor(state)

Gets the currently focused item ID.

new(opts)

Creates new Menu widget props.

separator()

Creates a separator.

submenu(id, label, children)

Creates a submenu item.