bobatea 0.0.2

Terminal layout + styling you won't hate.
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

//! Help / keybind hint bar — contextual shortcuts display.
//!
//! ```rust
//! use bobatea::components::help::{HelpBar, Keybind};
//! let bar = HelpBar::new(vec![
//!     Keybind::new("q", "quit"),
//!     Keybind::new("space", "click"),
//!     Keybind::new("Ctrl+P", "palette"),
//! ]);
//! ```

use {
    crate::components::Component,
    ratatui::{
        prelude::{Buffer, Frame, Rect},
        text::{Line, Span},
        widgets::{Paragraph, Widget},
    },
    std::fmt::Display,
};

/// A single keybind hint.
pub struct Keybind {
    key: String,
    desc: String,
}

impl Keybind {
    pub fn new(key: impl Display, desc: impl Display) -> Self { Self { key: key.to_string(), desc: desc.to_string() } }
}

/// A help bar that displays keybinds like vim's command bar.
pub struct HelpBar {
    binds: Vec<Keybind>,
    separator: String,
}

impl HelpBar {
    pub fn new(binds: Vec<Keybind>) -> Self { Self { binds, separator: "  ".into() } }

    pub fn with_separator(mut self, sep: impl Into<String>) -> Self {
        self.separator = sep.into();
        self
    }

    pub fn render_to_buf(&self, area: Rect, buf: &mut Buffer, theme: &crate::theme::Theme) {
        let help = &theme.help;
        let spans: Vec<Span> = self
            .binds
            .iter()
            .flat_map(|b| {
                vec![
                    Span::styled(format!(" {} ", b.key), ratatui::style::Style::default().fg(help.key_fg).bg(help.key_bg)),
                    Span::styled(format!(" {} ", b.desc), ratatui::style::Style::default().fg(help.desc_fg)),
                    Span::styled(self.separator.clone(), ratatui::style::Style::default().fg(help.separator_fg)),
                ]
            })
            .collect();

        let line = Line::from(spans);
        Paragraph::new(line).style(ratatui::style::Style::default().bg(theme.global_bg)).render(area, buf);
    }
}

impl Component for HelpBar {
    fn height(&self) -> Option<usize> { Some(1) }

    fn render(&mut self, ctx: &mut Frame<'_>, theme: &crate::theme::Theme) {
        let area = ctx.area();
        self.render_to_buf(area, ctx.buffer_mut(), theme);
    }
}