Struct tui_menu::MenuState

pub struct MenuState<T> { /* private fields */ }

The state for menu, keep track of runtime info

Implementations

impl<T: Clone> MenuState<T>

pub fn new(items: Vec<MenuItem<T>>) -> Self

create with items

Example

use tui_menu::{MenuState, MenuItem};

let state = MenuState::<&'static str>::new(vec![
    MenuItem::item("Foo", "label_foo"),
    MenuItem::group("Group", vec![
        MenuItem::item("Bar 1", "label_bar_1"),
        MenuItem::item("Bar 2", "label_bar_1"),
    ])
]);

pub fn activate(&mut self)

active the menu, this will select the first item

Example

use tui_menu::{MenuState, MenuItem};

let mut state = MenuState::<&'static str>::new(vec![
    MenuItem::item("Foo", "label_foo"),
    MenuItem::group("Group", vec![
        MenuItem::item("Bar 1", "label_bar_1"),
        MenuItem::item("Bar 2", "label_bar_1"),
    ])
]);

state.activate();

assert_eq!(state.highlight().unwrap().data.unwrap(), "label_foo");

pub fn up(&mut self)

trigger up movement NOTE: this action tries to do intuitive movement, which means logicially it is not consistent, e.g: case 1: group 1 group 2 group 3 > sub item 1 sub item 2 up is pop, which closes the group 2

case 2: group 1 group 2 group 3 sub item 1 > sub item 2 up is move prev

case 3:

group 1 group 2
sub item 1 > sub item 2 > sub sub item 1 sub sub item 2

up does nothing

pub fn down(&mut self)

trigger down movement

NOTE: this action tries to do intuitive movement, which means logicially it is not consistent, e.g: case 1: group 1 > group 2 group 3 sub item 1 sub item 2 down is enter, which enter the sub group of group 2

case 2: group 1 group 2 group 3 sub item 1 > sub item 2 down does nothing

case 3: group 1 group 2
> sub item 1 sub item 2

down highlights “sub item 2”

pub fn left(&mut self)

trigger left movement

NOTE: this action tries to do intuitive movement, which means logicially it is not consistent, e.g: case 1: group 1 > group 2 group 3 sub item 1 sub item 2 left highlights “group 1”

case 2: group 1 group 2 group 3 sub item 1 > sub item 2 left first pop “sub item group”, then highlights “group 1”

case 3: group 1 group 2
> sub item 1 sub sub item 1 sub item 2 > sub sub item 2

left pop “sub sub group”

pub fn right(&mut self)

trigger right movement

NOTE: this action tries to do intuitive movement, which means logicially it is not consistent, e.g: case 1: group 1 > group 2 group 3 sub item 1 sub item 2 right highlights “group 3”

case 2: group 1 group 2 group 3 sub item 1 > sub item 2 right pop group “sub item *”, then highlights “group 3”

case 3: group 1 group 2 group 3 sub item 1 > sub item 2 + right pushes “sub sub item 2”. this differs from case 2 that current highlighted item can be expanded

pub fn select(&mut self)

select current highlight item, if it has children then push

pub fn push(&mut self) -> Option<()>

dive into sub menu if applicable. Return: Some if entered deeper level None if nothing happen

pub fn pop(&mut self)

pop the current menu group. move one layer up

pub fn reset(&mut self)

clear all highlighted items. This is useful when the menu bar lose focus

pub fn drain_events(&mut self) -> impl Iterator<Item = MenuEvent<T>>

client should drain events each frame, otherwise user action will feel laggy

pub fn highlight(&self) -> Option<&MenuItem<T>>

return current highlighted item’s reference