Struct Menu 

pub struct Menu {
    pub title: String,
    pub items: Vec<MenuItem>,
    pub enabled: bool,
    pub hotkey: Option<char>,
    pub focused_item: Option<usize>,
}

A menu containing a title and a collection of menu items.

Menus are displayed as dropdowns when opened and support keyboard navigation with hotkeys for quick access.

Fields

title: String

Title text displayed in the menu bar

items: Vec<MenuItem>

Collection of menu items in this menu

enabled: bool

Whether the menu is enabled

hotkey: Option<char>

Optional hotkey for quick access to this menu

focused_item: Option<usize>

Index of the currently focused item when this menu is open

Implementations

impl Menu

pub fn new(title: impl Into<String>) -> Self

Creates a new menu with the given title.

pub fn with_hotkey(title: impl Into<String>, hotkey: char) -> Self

Creates a new menu with a hotkey.

pub fn with_items<S: Into<String>>( title: S, hotkey: Option<char>, items: Vec<MenuItem>, ) -> Self

Creates a new menu with title, hotkey, and items.

Example

use tui_vision::menus::{Menu, MenuItem};

let menu = Menu::with_items("File", Some('F'), vec![
    MenuItem::new_action("New", "file.new"),
    MenuItem::separator(),
]);

pub fn hotkey(self, hotkey: char) -> Self

Sets the hotkey for this menu (builder pattern).

pub fn item(self, item: MenuItem) -> Self

Adds an item to this menu (builder pattern).

pub fn items(self, items: Vec<MenuItem>) -> Self

Adds multiple items to this menu (builder pattern).

pub fn add_action<S: Into<String>, C: Into<Command>>( &mut self, label: S, command: C, hotkey: Option<char>, ) -> &mut Self

Adds an action item as a convenience method.

pub fn add_separator(&mut self) -> &mut Self

Adds a separator as a convenience method.

pub fn add_submenu<S: Into<String>>( &mut self, label: S, hotkey: Option<char>, ) -> &mut Self

Adds a submenu as a convenience method.

pub fn add_item(&mut self, item: MenuItem)

Adds a menu item to this menu.

impl Menu

pub fn set_enabled(&mut self, enabled: bool)

Sets the enabled state of the menu.

pub fn focus_next_item(&mut self)

Focus the next selectable item.

pub fn focus_previous_item(&mut self)

Focus the previous selectable item.

pub fn get_focused_item(&self) -> Option<&MenuItem>

Get the currently focused menu item.

pub fn close_all_submenus(&mut self)

Close all open submenus.

pub fn find_first_selectable_item(&self) -> Option<usize>

Find the first selectable (non-separator) menu item.

pub fn find_last_selectable_item(&self) -> Option<usize>

Find the last selectable menu item.

pub fn find_next_selectable_item(&self, current: usize) -> Option<usize>

Find the next selectable menu item after the given index.

pub fn find_previous_selectable_item(&self, current: usize) -> Option<usize>

Find the previous selectable menu item before the given index.

Trait Implementations

impl Clone for Menu

fn clone(&self) -> Menu

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Menu

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Menu

fn eq(&self, other: &Menu) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Menu

impl StructuralPartialEq for Menu