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

use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::text::Line;
use ratatui::widgets::Widget;

use crate::theme::Theme;

#[derive(Debug, Clone, Copy, Default)]
pub enum DividerVariant {
    Heavy,
    #[default]
    Light,
}

pub struct Divider<'a, T: Theme> {
    theme: &'a T,
    variant: DividerVariant,
    character: Option<char>,
}

impl<'a, T: Theme> Divider<'a, T> {
    pub fn new(theme: &'a T) -> Self {
        Self {
            theme,
            variant: DividerVariant::Light,
            character: None,
        }
    }

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

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

impl<T: Theme> Widget for Divider<'_, T> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        if area.height == 0 || area.width == 0 {
            return;
        }

        let (default_character, style) = match self.variant {
            DividerVariant::Heavy => ('━', self.theme.border_focused()),
            DividerVariant::Light => ('─', self.theme.border_unfocused()),
        };

        let character = self.character.unwrap_or(default_character);
        let line = character.to_string().repeat(area.width as usize);
        Line::styled(line, style).render(Rect::new(area.x, area.y, area.width, 1), buf);
    }
}

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

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

    #[test]
    fn light_variant_renders_light_character() {
        let theme = EddaCraftTheme;
        let mut buf = Buffer::empty(Rect::new(0, 0, 5, 1));

        Divider::new(&theme)
            .variant(DividerVariant::Light)
            .render(Rect::new(0, 0, 5, 1), &mut buf);

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

    #[test]
    fn custom_character_overrides_variant() {
        let theme = EddaCraftTheme;
        let mut buf = Buffer::empty(Rect::new(0, 0, 5, 1));

        Divider::new(&theme)
            .variant(DividerVariant::Heavy)
            .character('=')
            .render(Rect::new(0, 0, 5, 1), &mut buf);

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