menu

terminal_menu

Function 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/cancel.rs (lines 7-10)
5fn main() {
6    use terminal_menu::{menu, label, button, run, mut_menu};
7    let menu = menu(vec![
8        label("press the button or hit 'q' or esc!"),
9        button("button")
10    ]);
11    run(&menu);
12
13    // true if exited with 'q' or esc, false if button was pressed
14    println!("{}", mut_menu(&menu).canceled());
15}
More examples
Hide additional examples
examples/long.rs (lines 7-12)
5fn main() {
6    use terminal_menu::{menu, button, run, mut_menu};
7    let menu = menu(
8
9        // create buttons representing numbers from 1 to 100
10        (1..100).map(|n| button(format!("{}", n))).collect()
11
12    );
13    run(&menu);
14    if mut_menu(&menu).canceled() {
15        println!("Canceled!");
16        return;
17    }
18    println!("{}", mut_menu(&menu).selected_item_name());
19}
examples/async.rs (lines 7-10)
5fn main() {
6    use terminal_menu::{menu, label, button, activate, wait_for_exit};
7    let menu = menu(vec![
8        label("do work when menu open!"),
9        button("get me out of here!")
10    ]);
11
12    // like run but doesn't block
13    activate(&menu);
14
15    // do stuff
16    let mut num: usize = 1;
17    for i in 2..10 {
18        num *= i;
19    }
20
21    wait_for_exit(&menu);
22    println!("{}", num);
23}
examples/colors.rs (lines 11-20)
5fn main() {
6    use terminal_menu::*;
7
8    // see the crossterm crate for all the color options
9    use crossterm::style::Color;
10
11    let menu = menu(vec![
12
13        label("COLOR!"),
14        label("Red").colorize(Color::Red),
15        label("Green").colorize(Color::Green),
16        label("Blue").colorize(Color::Blue),
17
18        // selected item is always cyan
19        button("Cyan")
20    ]);
21    run(&menu);
22}
examples/readme.rs (lines 3-15)
1fn main() {
2    use terminal_menu::{run, menu, label, scroll, list, string, password, numeric, submenu, back_button};
3    let menu = menu(vec![
4        label("--------------"),
5        label("MY lovely menu!"),
6        label("usage: tinker around"),
7        label("---------------"),
8        scroll("Selection", vec!["First Option", "Second Option", "Third Option"]),
9        list("Do Something", vec!["Yes", "No"]),
10        string("Your Name", "Samuel", false),
11        password("Your Password", "pass", false),
12        numeric("Numeric", 5.25, None, None, None),
13        submenu("Submenu", vec![back_button("Back")]),
14        back_button("Exit"),
15    ]);
16    run(&menu);
17}
examples/simple.rs (lines 7-24)
5fn main() {
6    use terminal_menu::{menu, label, button, run, mut_menu};
7    let menu = menu(vec![
8
9        // label:
10        //  not selectable, useful as a title, separator, etc...
11        label("----------------------"),
12        label("terminal-menu"),
13        label("use wasd or arrow keys"),
14        label("enter to select"),
15        label("'q' or esc to exit"),
16        label("-----------------------"),
17
18        // button:
19        //  exit the menu
20        button("Alice"),
21        button("Bob"),
22        button("Charlie")
23
24    ]);
25    run(&menu);
26
27    // if the menu was exited
28    if (mut_menu(&menu).canceled()) {
29        println!("Canceled!");
30        return;
31    }
32
33    // you can get the selected buttons name like so:
34    println!("Selected: {}", mut_menu(&menu).selected_item_name());
35}
Additional examples can be found in: