ratatui-macros 0.7.0

Macros for Ratatui
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

/// A macro for creating a [`Line`] using vec! syntax.
///
/// `line!` is similar to the [`vec!`] macro, but it returns a [`Line`] instead of a `Vec`.
///
/// # Examples
///
/// * Create a [`Line`] containing a vector of [`Span`]s:
///
/// ```rust
/// # use ratatui_core::style::Stylize;
/// use ratatui_macros::line;
///
/// let line = line!["hello", "world"];
/// let line = line!["hello".red(), "world".red().bold()];
/// ```
///
/// * Create a [`Line`] from a given [`Span`] repeated some amount of times:
///
/// ```rust
/// # use ratatui_macros::line;
/// let line = line!["hello"; 2];
/// ```
///
/// * Use [`span!`] macro inside [`line!`] macro for formatting.
///
/// ```rust
/// # use ratatui_core::style::Modifier;
/// use ratatui_macros::{line, span};
///
/// let line = line![span!("hello {}", "world"), span!(Modifier::BOLD; "goodbye {}", "world")];
/// ```
///
/// [`span!`]: crate::span
/// [`Line`]: ratatui_core::text::Line
/// [`Span`]: ratatui_core::text::Span
/// [`vec!`]: alloc::vec!
#[macro_export]
macro_rules! line {
    () => {
        $crate::ratatui_core::text::Line::default()
    };
    ($span:expr; $n:expr) => {
      $crate::ratatui_core::text::Line::from($crate::vec![$span.into(); $n])
    };
    ($($span:expr),+ $(,)?) => {{
        $crate::ratatui_core::text::Line::from($crate::vec![
        $(
            $span.into(),
        )+
        ])
    }};
}

#[cfg(test)]
mod tests {
    use alloc::vec;
    use ratatui_core::text::{Line, Span};

    #[test]
    fn line_literal() {
        let line = line!["hello", "world"];
        assert_eq!(line, Line::from(vec!["hello".into(), "world".into()]));
    }

    #[test]
    fn line_raw_instead_of_literal() {
        let line = line![Span::raw("hello"), "world"];
        assert_eq!(line, Line::from(vec!["hello".into(), "world".into()]));
    }

    #[test]
    fn line_vec_count_syntax() {
        let line = line!["hello"; 2];
        assert_eq!(line, Line::from(vec!["hello".into(), "hello".into()]));
    }

    #[test]
    fn line_vec_count_syntax_with_span() {
        let line = line![crate::span!("hello"); 2];
        assert_eq!(line, Line::from(vec!["hello".into(), "hello".into()]));
    }

    #[test]
    fn line_empty() {
        let line = line![];
        assert_eq!(line, Line::default());
    }

    #[test]
    fn line_single_span() {
        let line = line![Span::raw("foo")];
        assert_eq!(line, Line::from(vec!["foo".into()]));
    }

    #[test]
    fn line_repeated_span() {
        let line = line![Span::raw("foo"); 2];
        assert_eq!(line, Line::from(vec!["foo".into(), "foo".into()]));
    }
}