eddacraft-tui 0.2.3

Shared Ratatui component library for the eddacraft product family
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

use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::text::Line;
use ratatui::widgets::{Block, BorderType, Borders, Widget};

use crate::theme::Theme;

#[derive(Debug, Clone, Copy, Default)]
pub enum ContainerVariant {
    Primary,
    #[default]
    Secondary,
    Subtle,
}

pub struct Container<'a, T: Theme> {
    theme: &'a T,
    title: Option<&'a str>,
    variant: ContainerVariant,
}

impl<'a, T: Theme> Container<'a, T> {
    pub fn new(theme: &'a T) -> Self {
        Self {
            theme,
            title: None,
            variant: ContainerVariant::Secondary,
        }
    }

    #[must_use]
    pub fn title(mut self, title: &'a str) -> Self {
        self.title = title.into();
        self
    }

    #[must_use]
    pub fn variant(mut self, variant: ContainerVariant) -> Self {
        self.variant = variant;
        self
    }

    #[must_use]
    pub fn to_block(&self) -> Block<'a> {
        let (border_type, border_style, title_style) = match self.variant {
            ContainerVariant::Primary => (
                BorderType::Double,
                self.theme.border_focused(),
                self.theme.title(),
            ),
            ContainerVariant::Secondary => (
                BorderType::Plain,
                self.theme.border_focused(),
                self.theme.title(),
            ),
            ContainerVariant::Subtle => (
                BorderType::Rounded,
                self.theme.border_unfocused(),
                self.theme.disabled(),
            ),
        };

        let mut block = Block::default()
            .borders(Borders::ALL)
            .border_type(border_type)
            .border_style(border_style);

        if let Some(title) = self.title {
            block = block.title(Line::styled(title, title_style));
        }

        block
    }

    #[must_use]
    pub fn inner(&self, area: Rect) -> Rect {
        self.to_block().inner(area)
    }
}

impl<T: Theme> Widget for Container<'_, T> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        self.to_block().render(area, buf);
    }
}

#[cfg(test)]
mod tests {
    use ratatui::widgets::Widget;

    use super::*;
    use crate::theme::EddaCraftTheme;

    #[test]
    fn primary_variant_renders_double_border() {
        let theme = EddaCraftTheme;
        let mut buf = Buffer::empty(Rect::new(0, 0, 6, 3));

        Container::new(&theme)
            .variant(ContainerVariant::Primary)
            .render(Rect::new(0, 0, 6, 3), &mut buf);

        assert_eq!(buf[(0, 0)].symbol(), "╔");
    }

    #[test]
    fn subtle_variant_renders_rounded_border() {
        let theme = EddaCraftTheme;
        let mut buf = Buffer::empty(Rect::new(0, 0, 6, 3));

        Container::new(&theme)
            .variant(ContainerVariant::Subtle)
            .render(Rect::new(0, 0, 6, 3), &mut buf);

        assert_eq!(buf[(0, 0)].symbol(), "╭");
    }
}