Function terminal_menu::menu

source · 
pub fn menu(items: Vec<TerminalMenuItem>) -> TerminalMenu
Expand description

Create a terminal-menu. See the examples for more.

Example

use terminal_menu::*;
let my_menu = menu(vec![
    label("label"),
    button("button"),
    scroll("scroll", vec!["a", "b", "c"])
]);
run(&my_menu);
{
    let mm = mut_menu(&my_menu);
    println!("{}", mm.selection_value("scroll"));
    println!("{}", mm.selected_item_name());
}
Examples found in repository?
examples/long.rs (lines 7-12)
5
6
7
8
9
10
11
12
13
14
15

fn main() {
    use terminal_menu::{menu, button, run, mut_menu};
    let menu = menu(

        // create buttons representing numbers from 1 to 100
        (1..100).map(|n| button(format!("{}", n))).collect()

    );
    run(&menu);
    println!("{}", mut_menu(&menu).selected_item_name());
}
More examples
Hide additional examples
examples/cancel.rs (lines 7-10)
5
6
7
8
9
10
11
12
13
14
15

fn main() {
    use terminal_menu::{menu, label, button, run, mut_menu};
    let menu = menu(vec![
        label("press the button or hit 'q' or esc!"),
        button("button")
    ]);
    run(&menu);

    // true if exited with 'q' or esc, false if button was pressed
    println!("{}", mut_menu(&menu).canceled());
}
examples/async.rs (lines 7-10)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

fn main() {
    use terminal_menu::{menu, label, button, activate, wait_for_exit};
    let menu = menu(vec![
        label("do work when menu open!"),
        button("get me out of here!")
    ]);

    // like run but doesn't block
    activate(&menu);

    // do stuff
    let mut num: usize = 1;
    for i in 2..10 {
        num *= i;
    }

    wait_for_exit(&menu);
    println!("{}", num);
}
examples/colors.rs (lines 11-20)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

fn main() {
    use terminal_menu::*;

    // see the crossterm crate for all the color options
    use crossterm::style::Color;

    let menu = menu(vec![

        label("COLOR!"),
        label("Red").colorize(Color::Red),
        label("Green").colorize(Color::Green),
        label("Blue").colorize(Color::Blue),

        // selected item is always cyan
        button("Cyan")
    ]);
    run(&menu);
}
examples/readme.rs (lines 3-14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

fn main() {
    use terminal_menu::{run, menu, label, scroll, list, string, numeric, submenu, back_button};
    let menu = menu(vec![
        label("--------------"),
        label("MY lovely menu!"),
        label("usage: tinker around"),
        label("---------------"),
        scroll("Selection", vec!["First Option", "Second Option", "Third Option"]),
        list("Do Something", vec!["Yes", "No"]),
        string("Your Name", "Samuel", false),
        numeric("Numeric", 5.25, None, None, None),
        submenu("Submenu", vec![back_button("Back")]),
        back_button("Exit"),
    ]);
    run(&menu);
}
examples/simple.rs (lines 7-24)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

fn main() {
    use terminal_menu::{menu, label, button, run, mut_menu};
    let menu = menu(vec![

        // label:
        //  not selectable, useful as a title, separator, etc...
        label("----------------------"),
        label("terminal-menu"),
        label("use wasd or arrow keys"),
        label("enter to select"),
        label("'q' or esc to exit"),
        label("-----------------------"),

        // button:
        //  exit the menu
        button("Alice"),
        button("Bob"),
        button("Charlie")

    ]);
    run(&menu);

    // you can get the selected buttons name like so:
    println!("Selected: {}", mut_menu(&menu).selected_item_name());
}
Additional examples can be found in: