kaolin 0.1.10

A Rust library for flexible layouts, inspired by Clay
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

use derive_default_constructor::DefaultConstructor;
use derive_setters::Setters;

#[derive(Default, Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub enum Direction {
    /// Default. Lays out elements from left to right.
    #[default]
    LeftToRight,
    /// Lays out elements from top to bottom.
    TopToBottom,
    /// Lays out elements from right to left.
    RightToLeft,
    /// Lays out elements from bottom to top.
    BottomToTop,
}

impl Direction {
    /// Returns true if the direction is horizontal (LeftToRight or RightToLeft).
    #[inline]
    pub fn is_horizontal(&self) -> bool {
        matches!(self, Direction::LeftToRight | Direction::RightToLeft)
    }
}

// /// Shorthand for layout directions.
// ///
// /// - `Layout::new().direction!(ltr)` for Left to Right
// /// - `Layout::new().direction!(ttb)` for Top to Bottom
// /// - `Layout::new().direction!(rtl)` for Right to Left
// /// - `Layout::new().direction!(btt)` for Bottom to Top
// #[macro_export]
// macro_rules! direction {
//     (ltr) => {
//         direction($crate::style::layout::Direction::LeftToRight)
//     };
//     (ttb) => {
//         direction($crate::style::layout::Direction::TopToBottom)
//     };
//     (rtl) => {
//         direction($crate::style::layout::Direction::RightToLeft)
//     };
//     (btt) => {
//         direction($crate::style::layout::Direction::BottomToTop)
//     };
// }

#[derive(Default, Clone, Copy)]
pub enum Alignment {
    /// Aligns the elements at the start of the cross axis (top with horizontal layout, left with vertical layout).
    #[default]
    Start,
    /// Aligns the elements at the end of the cross axis (bottom with horizontal layout, right with vertical layout).
    End,
    /// Aligns the elements at the center of the cross axis.
    Center,
    /// Stretches the elements to fill the cross axis.
    Stretch,
}

#[derive(Default, Clone, Copy)]
pub enum Justification {
    /// Aligns the elements at the start of the main axis.
    #[default]
    Start,
    /// Aligns the elements at the end of the main axis.
    End,
    /// Aligns the elements at the center of the main axis.
    Center,
    /// Distributes the elements evenly, with the first element at the start and the last at the end.
    SpaceBetween,
    /// Distributes the elements evenly, with equal space around them.
    SpaceAround,
}

/// Layout properties for the flex container (a.k.a, where do we put its children?)
#[derive(Default, DefaultConstructor, Clone, Copy, Setters)]
pub struct Layout {
    /// The direction in which child elements are laid out.
    pub direction: Direction,
    /// The alignment of child elements along the cross axis.
    pub alignment: Alignment,
    /// The justification of child elements along the main axis.
    pub justification: Justification,
    /// The gap between child elements.
    pub gap: f64,
}

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

//     #[test]
//     fn test_layout_direction() {
//         let layout = Layout::new().direction!(ltr);
//         assert_eq!(layout.direction, Direction::LeftToRight);
//     }

//     #[test]
//     fn test_layout_alignment() {
//         let layout = Layout::new().alignment!(center);
//         assert_eq!(layout.alignment, Alignment::Center);
//     }

//     #[test]
//     fn test_layout_justification() {
//         let layout = Layout::new().justification!(space_between);
//         assert_eq!(layout.justification, Justification::SpaceBetween);
//     }

//     #[test]
//     fn test_layout_gap() {
//         let layout = Layout::new().gap!(10.0);
//         assert_eq!(layout.gap, 10.0);
//     }
// }