tui-menu 0.3.1

A menu widget for Ratatui
Documentation 
1
2
3
4
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use ratatui::{
    crossterm::event::{self, Event, KeyCode},
    prelude::*,
    widgets::{Block, Paragraph},
};
use tui_menu::{Menu, MenuEvent, MenuItem, MenuState};

fn main() -> color_eyre::Result<()> {
    color_eyre::install()?;

    ratatui::run(|t| App::new().run(t))?;
    Ok(())
}

struct App {
    content: String,
    menu: MenuState<Action>,
}

impl App {
    fn new() -> Self {
        Self {
            content: String::new(),
            menu: MenuState::new(vec![
                MenuItem::group(
                    "Group 1",
                    vec![
                        MenuItem::group(
                            "Nested",
                            vec![MenuItem::group(
                                "Nested 1",
                                vec![MenuItem::group(
                                    "Nested 2",
                                    vec![
                                        MenuItem::group(
                                            "Nested 3",
                                            vec![MenuItem::group(
                                                "Nested 4",
                                                vec![
                                                    MenuItem::group(
                                                        "Nested 5",
                                                        vec![MenuItem::group("Nested 6", vec![])],
                                                    ),
                                                    MenuItem::item("Item 5", Action::Exit),
                                                ],
                                            )],
                                        ),
                                        MenuItem::item("Item 3a", Action::Exit),
                                    ],
                                )],
                            )],
                        ),
                        MenuItem::item("Exit", Action::Exit),
                    ],
                ),
                MenuItem::item("Exit", Action::Exit),
            ]),
        }
    }
}

#[derive(Debug, Clone)]
enum Action {
    Exit,
}

impl App {
    fn run(mut self, terminal: &mut ratatui::DefaultTerminal) -> std::io::Result<()> {
        loop {
            terminal.draw(|frame| frame.render_widget(&mut self, frame.area()))?;

            if event::poll(std::time::Duration::from_millis(10))? {
                if let Event::Key(key) = event::read()? {
                    self.on_key_event(key);
                }
            }

            for e in self.menu.drain_events() {
                match e {
                    MenuEvent::Selected(item) => match item {
                        Action::Exit => {
                            return Ok(());
                        }
                    },
                }
            }
        }
    }

    fn on_key_event(&mut self, key: event::KeyEvent) {
        match key.code {
            KeyCode::Char('h') | KeyCode::Left => self.menu.left(),
            KeyCode::Char('l') | KeyCode::Right => self.menu.right(),
            KeyCode::Char('j') | KeyCode::Down => self.menu.down(),
            KeyCode::Char('k') | KeyCode::Up => self.menu.up(),
            KeyCode::Esc => self.menu.reset(),
            KeyCode::Enter => self.menu.select(),
            _ => {}
        }
    }
}

impl Widget for &mut App {
    fn render(self, area: Rect, buf: &mut Buffer) {
        use Constraint::*;
        let [_top, main] = Layout::vertical([Length(1), Fill(1)]).areas(area);

        Paragraph::new(self.content.as_str())
            .block(Block::bordered().title("Content").on_black())
            .render(main, buf);

        let [log, menu] = Layout::horizontal([Length(10), Fill(1)]).areas(area);
        "tui-menu"
            .bold()
            .blue()
            .into_centered_line()
            .render(log, buf);

        // draw menu last, so it renders on top of other content
        Menu::new().render(menu, buf, &mut self.menu);
    }
}