a3s-tui 0.1.11

TEA (The Elm Architecture) framework for terminal user interfaces
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use crate::element::{BoxElement, Element, FlexDirection, TextElement};
use crate::style::{fit_visible, Color, Style};

/// Inline action pill with optional muted detail text.
#[derive(Debug, Clone)]
pub struct InlineAction {
    label: String,
    icon: Option<String>,
    detail: Option<String>,
    fg: Color,
    bg: Color,
    detail_color: Color,
    bold: bool,
}

impl InlineAction {
    pub fn new(label: impl Into<String>) -> Self {
        Self {
            label: label.into(),
            icon: None,
            detail: None,
            fg: Color::BrightWhite,
            bg: Color::Cyan,
            detail_color: Color::BrightBlack,
            bold: true,
        }
    }

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

    pub fn detail(mut self, detail: impl Into<String>) -> Self {
        let detail = detail.into();
        self.detail = (!detail.trim().is_empty()).then_some(detail);
        self
    }

    pub fn colors(mut self, fg: Color, bg: Color) -> Self {
        self.fg = fg;
        self.bg = bg;
        self
    }

    pub fn detail_color(mut self, color: Color) -> Self {
        self.detail_color = color;
        self
    }

    pub fn bold(mut self, enabled: bool) -> Self {
        self.bold = enabled;
        self
    }

    pub fn view(&self) -> String {
        let action = self.action_text();
        let mut style = Style::new().fg(self.fg).bg(self.bg);
        if self.bold {
            style = style.bold();
        }
        let button = style.render(&action);
        match self
            .detail
            .as_deref()
            .map(str::trim)
            .filter(|detail| !detail.is_empty())
        {
            Some(detail) => format!(
                "{button} {}",
                Style::new().fg(self.detail_color).render(detail)
            ),
            None => button,
        }
    }

    pub fn view_with_width(&self, width: u16) -> String {
        fit_visible(&self.view(), width as usize)
    }

    pub fn element<Msg>(&self) -> Element<Msg> {
        let mut children = vec![Element::Text(self.action_element_text())];
        if let Some(detail) = self
            .detail
            .as_deref()
            .map(str::trim)
            .filter(|detail| !detail.is_empty())
        {
            children.push(Element::Text(TextElement::new(" ")));
            children.push(Element::Text(
                TextElement::new(detail).fg(self.detail_color),
            ));
        }

        Element::Box(
            BoxElement::new()
                .direction(FlexDirection::Row)
                .children(children),
        )
    }

    fn action_text(&self) -> String {
        match self
            .icon
            .as_deref()
            .map(str::trim)
            .filter(|icon| !icon.is_empty())
        {
            Some(icon) => format!(" {icon} {} ", self.label),
            None => format!(" {} ", self.label),
        }
    }

    fn action_element_text(&self) -> TextElement {
        let mut text = TextElement::new(self.action_text()).fg(self.fg).bg(self.bg);
        if self.bold {
            text = text.bold();
        }
        text
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::style::{strip_ansi, visible_len};

    #[test]
    fn view_renders_action_and_detail() {
        let rendered = InlineAction::new("Open view")
            .icon("↗")
            .colors(Color::BrightWhite, Color::Blue)
            .detail("click or /view to open")
            .view();
        let plain = strip_ansi(&rendered);

        assert_eq!(plain, " ↗ Open view  click or /view to open");
        assert!(rendered.contains("\x1b["));
    }

    #[test]
    fn empty_detail_is_omitted() {
        let rendered = InlineAction::new("Run").detail("  ").view();

        assert_eq!(strip_ansi(&rendered), " Run ");
    }

    #[test]
    fn view_with_width_bounds_visible_length() {
        let rendered = InlineAction::new("Open view")
            .icon("↗")
            .detail("a very long detail")
            .view_with_width(12);

        assert_eq!(visible_len(&rendered), 12);
    }

    #[test]
    fn element_contains_button_and_detail_rows() {
        let el: Element<()> = InlineAction::new("Open view")
            .icon("↗")
            .detail("click")
            .element();

        let Element::Box(row) = el else {
            panic!("expected row");
        };
        assert_eq!(row.style.flex_direction, FlexDirection::Row);
        assert_eq!(row.children.len(), 3);
        assert_eq!(row.children[0].text_content(), Some(" ↗ Open view "));
        assert_eq!(row.children[2].text_content(), Some("click"));
    }
}