tuirealm 4.0.0

A tui-rs framework to build tui interfaces, inspired by React and Elm.
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

use std::collections::HashMap;

use crate::props::{AttrValue, Attribute, QueryResult};

/// The props struct holds all the attributes associated to the component.
/// Properties have been designed to be versatile for all kind of components, but without introducing
/// too many attributes at the same time.
#[derive(Debug, Default, PartialEq, Clone)]
pub struct Props {
    attrs: HashMap<Attribute, AttrValue>,
}

impl Props {
    /// Get, if any, the attribute associated to the selector by reference.
    pub fn get(&self, query: Attribute) -> Option<&AttrValue> {
        self.attrs.get(&query)
    }

    /// Get, if any, the attribute associated to the selector by mutable reference.
    pub fn get_mut(&mut self, query: Attribute) -> Option<&mut AttrValue> {
        self.attrs.get_mut(&query)
    }

    /// Get, if any, the attribute associated to the selector by reference and return as a type compatible with [`Component::query`](crate::component::Component::query).
    pub fn get_for_query<'a>(&'a self, query: Attribute) -> Option<QueryResult<'a>> {
        self.get(query).map(QueryResult::from)
    }

    /// Set a new attribute into Properties
    pub fn set(&mut self, query: Attribute, value: AttrValue) {
        self.attrs.insert(query, value);
    }
}

#[cfg(test)]
mod test {
    use pretty_assertions::assert_eq;
    use ratatui::layout::HorizontalAlignment;

    use super::*;

    #[test]
    fn should_set_get_props() {
        let mut props = Props::default();
        assert_eq!(props.get(Attribute::AlignmentHorizontal), None);
        assert_eq!(props.get(Attribute::AlignmentHorizontal), None);

        props.set(
            Attribute::AlignmentHorizontal,
            AttrValue::AlignmentHorizontal(HorizontalAlignment::Left),
        );
        assert_eq!(
            props.get(Attribute::AlignmentHorizontal),
            Some(&AttrValue::AlignmentHorizontal(HorizontalAlignment::Left))
        );
        assert_eq!(
            props.get(Attribute::AlignmentHorizontal),
            Some(&AttrValue::AlignmentHorizontal(HorizontalAlignment::Left))
        );

        let val = props.get_mut(Attribute::AlignmentHorizontal).unwrap();
        assert_eq!(
            val,
            &AttrValue::AlignmentHorizontal(HorizontalAlignment::Left)
        );
        let v = val.as_alignment_horizontal_mut().unwrap();
        *v = HorizontalAlignment::Center;

        assert_eq!(
            props.get(Attribute::AlignmentHorizontal).unwrap(),
            &AttrValue::AlignmentHorizontal(HorizontalAlignment::Center)
        );
    }
}