rnk 0.17.2

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

//! Highlight component for text highlighting
//!
//! Highlights text with customizable colors.
//!
//! # Example
//!
//! ```rust,ignore
//! use rnk::prelude::*;
//! use rnk::components::Highlight;
//!
//! fn app() -> Element {
//!     Box::new()
//!         .flex_direction(FlexDirection::Column)
//!         .children(vec![
//!             Highlight::new("Important text").into_element(),
//!             Highlight::new("Warning").variant(HighlightVariant::Warning).into_element(),
//!             Highlight::new("Error").variant(HighlightVariant::Error).into_element(),
//!         ])
//!         .into_element()
//! }
//! ```

use crate::components::capsule::capsule_padded;
use crate::core::{Color, Element};

/// Highlight variant
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum HighlightVariant {
    #[default]
    Default,
    Primary,
    Success,
    Warning,
    Error,
    Info,
}

/// A highlight component for emphasized text
#[derive(Debug, Clone)]
pub struct Highlight {
    text: String,
    variant: HighlightVariant,
}

impl Highlight {
    /// Create a new highlight
    pub fn new(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            variant: HighlightVariant::Default,
        }
    }

    /// Set the variant
    pub fn variant(mut self, variant: HighlightVariant) -> Self {
        self.variant = variant;
        self
    }

    /// Create a primary highlight
    pub fn primary(text: impl Into<String>) -> Self {
        Self::new(text).variant(HighlightVariant::Primary)
    }

    /// Create a success highlight
    pub fn success(text: impl Into<String>) -> Self {
        Self::new(text).variant(HighlightVariant::Success)
    }

    /// Create a warning highlight
    pub fn warning(text: impl Into<String>) -> Self {
        Self::new(text).variant(HighlightVariant::Warning)
    }

    /// Create an error highlight
    pub fn error(text: impl Into<String>) -> Self {
        Self::new(text).variant(HighlightVariant::Error)
    }

    /// Create an info highlight
    pub fn info(text: impl Into<String>) -> Self {
        Self::new(text).variant(HighlightVariant::Info)
    }

    /// Convert to Element
    pub fn into_element(self) -> Element {
        let (fg, bg) = match self.variant {
            HighlightVariant::Default => (Color::Black, Color::Yellow),
            HighlightVariant::Primary => (Color::White, Color::Blue),
            HighlightVariant::Success => (Color::White, Color::Green),
            HighlightVariant::Warning => (Color::Black, Color::Yellow),
            HighlightVariant::Error => (Color::White, Color::Red),
            HighlightVariant::Info => (Color::White, Color::Cyan),
        };

        capsule_padded(self.text, fg, bg).into_element()
    }
}

impl Default for Highlight {
    fn default() -> Self {
        Self::new("")
    }
}

/// Create a default highlight
pub fn highlight(text: impl Into<String>) -> Element {
    Highlight::new(text).into_element()
}

/// Create a primary highlight
pub fn highlight_primary(text: impl Into<String>) -> Element {
    Highlight::primary(text).into_element()
}

/// Create a success highlight
pub fn highlight_success(text: impl Into<String>) -> Element {
    Highlight::success(text).into_element()
}

/// Create a warning highlight
pub fn highlight_warning(text: impl Into<String>) -> Element {
    Highlight::warning(text).into_element()
}

/// Create an error highlight
pub fn highlight_error(text: impl Into<String>) -> Element {
    Highlight::error(text).into_element()
}

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

    #[test]
    fn test_highlight_creation() {
        let h = Highlight::new("Test");
        assert_eq!(h.text, "Test");
    }

    #[test]
    fn test_highlight_variants() {
        let _ = Highlight::primary("P").into_element();
        let _ = Highlight::success("S").into_element();
        let _ = Highlight::warning("W").into_element();
        let _ = Highlight::error("E").into_element();
        let _ = Highlight::info("I").into_element();
    }

    #[test]
    fn test_highlight_helpers() {
        let _ = highlight("Default");
        let _ = highlight_primary("Primary");
        let _ = highlight_success("Success");
        let _ = highlight_warning("Warning");
        let _ = highlight_error("Error");
    }
}