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

//! Link component for styled hyperlinks
//!
//! Displays styled links with optional icons.
//!
//! # Example
//!
//! ```rust,ignore
//! use rnk::prelude::*;
//! use rnk::components::Link;
//!
//! fn app() -> Element {
//!     Box::new()
//!         .flex_direction(FlexDirection::Column)
//!         .children(vec![
//!             Link::new("Documentation", "https://docs.rs/rnk").into_element(),
//!             Link::new("GitHub", "https://github.com").icon("").into_element(),
//!         ])
//!         .into_element()
//! }
//! ```

use crate::components::Text;
use crate::core::{Color, Element};

/// A link component
#[derive(Debug, Clone)]
pub struct Link {
    text: String,
    url: String,
    icon: Option<String>,
    color: Color,
    underline: bool,
}

impl Link {
    /// Create a new link
    pub fn new(text: impl Into<String>, url: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            url: url.into(),
            icon: None,
            color: Color::Cyan,
            underline: true,
        }
    }

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

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

    /// Disable underline
    pub fn no_underline(mut self) -> Self {
        self.underline = false;
        self
    }

    /// Get the URL
    pub fn url(&self) -> &str {
        &self.url
    }

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

        if let Some(icon) = &self.icon {
            content.push_str(icon);
            content.push(' ');
        }

        content.push_str(&self.text);

        let mut text = Text::new(content).color(self.color);
        if self.underline {
            text = text.underline();
        }
        text.into_element()
    }
}

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

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

    #[test]
    fn test_link_creation() {
        let l = Link::new("Text", "https://example.com");
        assert_eq!(l.text, "Text");
        assert_eq!(l.url, "https://example.com");
    }

    #[test]
    fn test_link_with_icon() {
        let l = Link::new("GitHub", "https://github.com").icon("");
        assert_eq!(l.icon, Some("".to_string()));
    }

    #[test]
    fn test_link_into_element() {
        let _ = Link::new("Test", "https://test.com").into_element();
        let _ = Link::new("Test", "https://test.com")
            .icon("*")
            .into_element();
        let _ = Link::new("Test", "https://test.com")
            .no_underline()
            .into_element();
    }
}