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

//! Spacer component - Flexible space in layouts

use crate::core::{Element, ElementType, Style};

/// Spacer component that expands to fill available space
///
/// Useful for pushing elements apart in a flex container.
///
/// # Example
///
/// ```ignore
/// Box::new()
///     .flex_direction(FlexDirection::Row)
///     .child(Text::new("Left").into_element())
///     .child(Spacer::new().into_element())
///     .child(Text::new("Right").into_element())
/// ```
#[derive(Debug, Clone, Default)]
pub struct Spacer {
    flex_grow: f32,
}

impl Spacer {
    /// Create a new spacer with flex-grow: 1
    pub fn new() -> Self {
        Self { flex_grow: 1.0 }
    }

    /// Set the flex grow value
    pub fn flex(mut self, grow: f32) -> Self {
        self.flex_grow = grow;
        self
    }

    /// Convert to Element
    pub fn into_element(self) -> Element {
        let mut element = Element::new(ElementType::Box);
        element.style = Style::new();
        element.style.flex_grow = self.flex_grow;
        element.style.flex_shrink = 0.0;
        element
    }
}

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

    #[test]
    fn test_spacer_default() {
        let element = Spacer::new().into_element();
        assert_eq!(element.style.flex_grow, 1.0);
        assert_eq!(element.style.flex_shrink, 0.0);
    }

    #[test]
    fn test_spacer_custom_flex() {
        let element = Spacer::new().flex(2.0).into_element();
        assert_eq!(element.style.flex_grow, 2.0);
    }
}