rnk 0.17.3

A React-like declarative terminal UI framework for Rust, inspired by Ink
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

//! Stat component for displaying statistics
//!
//! Displays key metrics with labels and optional trends.
//!
//! # Example
//!
//! ```rust,ignore
//! use rnk::prelude::*;
//! use rnk::components::Stat;
//!
//! fn dashboard() -> Element {
//!     Box::new()
//!         .flex_direction(FlexDirection::Row)
//!         .gap(2.0)
//!         .children(vec![
//!             Stat::new("Users", "1,234").trend_up("12%").into_element(),
//!             Stat::new("Revenue", "$5,678").trend_down("3%").into_element(),
//!             Stat::new("Orders", "89").into_element(),
//!         ])
//!         .into_element()
//! }
//! ```

use crate::components::{Box as RnkBox, Text};
use crate::core::{Color, Element, FlexDirection};

/// Trend direction
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Trend {
    Up,
    Down,
    Neutral,
}

/// A stat component for displaying metrics
#[derive(Debug, Clone)]
pub struct Stat {
    label: String,
    value: String,
    trend: Option<(Trend, String)>,
    help_text: Option<String>,
}

impl Stat {
    /// Create a new stat
    pub fn new(label: impl Into<String>, value: impl Into<String>) -> Self {
        Self {
            label: label.into(),
            value: value.into(),
            trend: None,
            help_text: None,
        }
    }

    /// Add an upward trend
    pub fn trend_up(mut self, change: impl Into<String>) -> Self {
        self.trend = Some((Trend::Up, change.into()));
        self
    }

    /// Add a downward trend
    pub fn trend_down(mut self, change: impl Into<String>) -> Self {
        self.trend = Some((Trend::Down, change.into()));
        self
    }

    /// Add a neutral trend
    pub fn trend_neutral(mut self, change: impl Into<String>) -> Self {
        self.trend = Some((Trend::Neutral, change.into()));
        self
    }

    /// Add help text
    pub fn help(mut self, text: impl Into<String>) -> Self {
        self.help_text = Some(text.into());
        self
    }

    /// Convert to Element
    pub fn into_element(self) -> Element {
        let mut children = Vec::new();

        // Label
        children.push(
            Text::new(&self.label)
                .color(Color::BrightBlack)
                .into_element(),
        );

        // Value with optional trend
        let mut value_children = vec![
            Text::new(&self.value)
                .color(Color::White)
                .bold()
                .into_element(),
        ];

        if let Some((trend, change)) = &self.trend {
            let (icon, color) = match trend {
                Trend::Up => ("↑", Color::Green),
                Trend::Down => ("↓", Color::Red),
                Trend::Neutral => ("→", Color::Yellow),
            };
            value_children.push(
                Text::new(format!(" {} {}", icon, change))
                    .color(color)
                    .into_element(),
            );
        }

        children.push(
            RnkBox::new()
                .flex_direction(FlexDirection::Row)
                .children(value_children)
                .into_element(),
        );

        // Help text
        if let Some(help) = &self.help_text {
            children.push(
                Text::new(help)
                    .color(Color::BrightBlack)
                    .dim()
                    .into_element(),
            );
        }

        RnkBox::new()
            .flex_direction(FlexDirection::Column)
            .children(children)
            .into_element()
    }
}

impl Default for Stat {
    fn default() -> Self {
        Self::new("", "0")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_stat_creation() {
        let s = Stat::new("Users", "100");
        assert_eq!(s.label, "Users");
        assert_eq!(s.value, "100");
    }

    #[test]
    fn test_stat_with_trend() {
        let s = Stat::new("Sales", "$500").trend_up("10%");
        assert!(matches!(s.trend, Some((Trend::Up, _))));
    }

    #[test]
    fn test_stat_into_element() {
        let _ = Stat::new("Test", "123").into_element();
        let _ = Stat::new("Test", "123").trend_up("5%").into_element();
        let _ = Stat::new("Test", "123").trend_down("3%").into_element();
    }
}