oxi-tui 0.1.4-alpha

Terminal UI framework with differential rendering, themes, and components
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

//! Text component - displays static or dynamic text.

use crate::{Cell, Color, Component, Event, Rect, Surface, Size, Theme};

/// Text component configuration.
#[derive(Debug, Clone)]
pub struct TextOptions {
    /// Text color.
    pub fg_color: Option<Color>,
    /// Background color.
    pub bg_color: Option<Color>,
    /// Alignment.
    pub align: TextAlign,
    /// When set, theme colors are used as defaults (overridden by explicit fg/bg).
    pub theme: Option<Theme>,
}

impl Default for TextOptions {
    fn default() -> Self {
        Self {
            fg_color: None,
            bg_color: None,
            align: TextAlign::Left,
            theme: None,
        }
    }
}

impl TextOptions {
    /// Create options pre-filled from a theme.
    pub fn from_theme(theme: &Theme) -> Self {
        Self {
            fg_color: Some(theme.colors.foreground),
            bg_color: Some(theme.colors.background),
            align: TextAlign::Left,
            theme: Some(theme.clone()),
        }
    }
}

/// Text alignment.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TextAlign {
    Left,
    Center,
    Right,
}

/// A simple text component.
pub struct Text {
    content: String,
    options: TextOptions,
    dirty: bool,
}

impl Text {
    pub fn new(content: &str) -> Self {
        Self {
            content: content.to_string(),
            options: TextOptions::default(),
            dirty: true,
        }
    }

    pub fn with_options(content: &str, options: TextOptions) -> Self {
        Self {
            content: content.to_string(),
            options,
            dirty: true,
        }
    }

    /// Set the theme; colors from the theme are used unless explicitly overridden.
    pub fn set_theme(&mut self, theme: &Theme) {
        self.options.theme = Some(theme.clone());
        // Only override if user hasn't set explicit colors
        if self.options.fg_color.is_none() {
            self.options.fg_color = Some(theme.colors.foreground);
        }
        if self.options.bg_color.is_none() {
            self.options.bg_color = Some(theme.colors.background);
        }
        self.dirty = true;
    }

    pub fn set_text(&mut self, content: &str) {
        if self.content != content {
            self.content = content.to_string();
            self.dirty = true;
        }
    }

    pub fn text(&self) -> &str {
        &self.content
    }
}

impl Component for Text {
    fn name(&self) -> &str {
        "Text"
    }

    fn request_render(&mut self) {
        self.dirty = true;
    }

    fn is_dirty(&self) -> bool {
        self.dirty
    }

    fn clear_dirty(&mut self) {
        self.dirty = false;
    }

    fn handle_event(&mut self, _event: &Event) -> bool {
        false
    }

    fn render(&mut self, surface: &mut Surface, area: Rect) {
        // Calculate alignment offset
        let text_width = self.content.len() as u16;
        let x_offset = match self.options.align {
            TextAlign::Left => 0,
            TextAlign::Center => (area.width.saturating_sub(text_width)) / 2,
            TextAlign::Right => area.width.saturating_sub(text_width),
        };

        // Write text
        let start_col = area.x + x_offset;
        for (i, c) in self.content.chars().enumerate() {
            let col = start_col + i as u16;
            if col < area.x + area.width {
                let mut cell = Cell::new(c);
                if let Some(fg) = self.options.fg_color {
                    cell.fg = fg;
                }
                if let Some(bg) = self.options.bg_color {
                    cell.bg = bg;
                }
                surface.set(area.y, col, cell);
            }
        }
    }

    fn min_size(&self) -> Size {
        Size {
            width: self.content.len() as u16,
            height: 1,
        }
    }
}