termtui 0.1.0

A framework for building beautiful, responsive terminal user interfaces with a DOM-style hierarchical approach
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

use crate::style::TextStyle;
use crate::{Color, TextWrap};

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// Text content with styling
#[derive(Debug, Clone, Default, PartialEq)]
pub struct Text {
    pub content: String,
    pub style: Option<TextStyle>,
}

//--------------------------------------------------------------------------------------------------
// Methods
//--------------------------------------------------------------------------------------------------

impl Text {
    /// Creates a new Text with the given content
    pub fn new(content: impl Into<String>) -> Self {
        Self {
            content: content.into(),
            style: None,
        }
    }

    /// Sets the text color
    pub fn color(mut self, color: Color) -> Self {
        self.style.get_or_insert(TextStyle::default()).color = Some(color);
        self
    }

    /// Sets the background color
    pub fn background(mut self, color: Color) -> Self {
        self.style.get_or_insert(TextStyle::default()).background = Some(color);
        self
    }

    /// Makes the text bold
    pub fn bold(mut self) -> Self {
        self.style.get_or_insert(TextStyle::default()).bold = Some(true);
        self
    }

    /// Makes the text italic
    pub fn italic(mut self) -> Self {
        self.style.get_or_insert(TextStyle::default()).italic = Some(true);
        self
    }

    /// Makes the text underlined
    pub fn underline(mut self) -> Self {
        self.style.get_or_insert(TextStyle::default()).underline = Some(true);
        self
    }

    /// Makes the text strikethrough
    pub fn strikethrough(mut self) -> Self {
        self.style.get_or_insert(TextStyle::default()).strikethrough = Some(true);
        self
    }

    /// Sets the text wrapping mode
    pub fn wrap(mut self, wrap: TextWrap) -> Self {
        self.style.get_or_insert(TextStyle::default()).wrap = Some(wrap);
        self
    }
}

//--------------------------------------------------------------------------------------------------
// Trait Implementations
//--------------------------------------------------------------------------------------------------

impl From<String> for Text {
    fn from(content: String) -> Self {
        Self::new(content)
    }
}

impl From<&str> for Text {
    fn from(content: &str) -> Self {
        Self::new(content)
    }
}