ratkit 0.2.16

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use ratatui::layout::Rect;
use ratatui_toolkit::split_layout::SplitLayout;

#[test]
fn test_split_layout_creation() {
    let layout = SplitLayout::new(0);
    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));

    assert_eq!(panes.len(), 1);
    assert_eq!(panes[0].pane_id(), 0);
}

#[test]
fn test_split_layout_vertical_split() {
    let mut layout = SplitLayout::new(0);
    let pane_1 = layout.split_pane_vertically(0);

    assert!(pane_1.is_some());
    assert_eq!(pane_1.unwrap(), 1);

    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes.len(), 2);

    assert_eq!(panes[0].area().width, 50);
    assert_eq!(panes[1].area().width, 50);
}

#[test]
fn test_split_layout_horizontal_split() {
    let mut layout = SplitLayout::new(0);
    let pane_1 = layout.split_pane_horizontally(0);

    assert!(pane_1.is_some());
    assert_eq!(pane_1.unwrap(), 1);

    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes.len(), 2);

    assert_eq!(panes[0].area().height, 50);
    assert_eq!(panes[1].area().height, 50);
}

#[test]
fn test_split_layout_resize_divider() {
    let mut layout = SplitLayout::new(0);
    let _pane_1 = layout.split_pane_vertically(0).unwrap();

    let success = layout.resize_divider(0, 30);
    assert!(success);

    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes[0].area().width, 30);
    assert_eq!(panes[1].area().width, 70);
}

#[test]
fn test_split_layout_resize_clamping() {
    let mut layout = SplitLayout::new(0);
    let _pane_1 = layout.split_pane_vertically(0).unwrap();

    let success = layout.resize_divider(0, 5);
    assert!(success);
    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes[0].area().width, 10);

    let success = layout.resize_divider(0, 95);
    assert!(success);
    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes[0].area().width, 90);
}

#[test]
fn test_split_layout_remove_pane() {
    let mut layout = SplitLayout::new(0);
    let pane_1 = layout.split_pane_vertically(0).unwrap();
    let pane_2 = layout.split_pane_horizontally(0).unwrap();

    let success = layout.remove_pane(pane_1.unwrap());
    assert!(success);

    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes.len(), 2);
}

#[test]
fn test_split_layout_move_pane() {
    let mut layout = SplitLayout::new(0);
    let pane_1 = layout.split_pane_vertically(0).unwrap();
    let pane_2 = layout.split_pane_vertically(pane_1.unwrap()).unwrap();

    let success = layout.move_pane(0, pane_2.unwrap());
    assert!(success);

    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    let moved_pane = panes.iter().find(|p| p.pane_id() == 0);
    assert!(moved_pane.is_some());
}

#[test]
fn test_split_layout_five_pane_grid() {
    let mut layout = SplitLayout::new(0);
    let pane_2 = layout.split_pane_horizontally(0).unwrap();
    let pane_3 = layout.split_pane_vertically(pane_2).unwrap();
    let pane_4 = layout.split_pane_vertically(1).unwrap();

    let _ = layout.resize_divider(0, 60);
    let _ = layout.resize_divider(pane_2, 50);
    let _ = layout.resize_divider(1, 50);

    let panes = layout.layout_panes(Rect::new(0, 0, 120, 80));
    assert_eq!(panes.len(), 5);

    let ids: Vec<u32> = panes.iter().map(|p| p.pane_id()).collect();
    let unique_ids: std::collections::HashSet<u32> = ids.iter().cloned().collect();
    assert_eq!(unique_ids.len(), 5);

    for pane in &panes {
        let area = pane.area();
        assert!(area.width > 0);
        assert!(area.height > 0);
    }
}

#[test]
fn test_split_layout_multiple_splits() {
    let mut layout = SplitLayout::new(0);

    let pane_1 = layout.split_pane_vertically(0).unwrap();
    let pane_2 = layout.split_pane_horizontally(pane_1).unwrap();
    let pane_3 = layout.split_pane_horizontally(pane_2).unwrap();

    let panes = layout.layout_panes(Rect::new(0, 0, 100, 100));
    assert_eq!(panes.len(), 4);

    for i in 0..panes.len() {
        for j in (i + 1)..panes.len() {
            let area1 = panes[i].area();
            let area2 = panes[j].area();

            let no_overlap = area1.x + area1.width <= area2.x
                || area2.x + area2.width <= area1.x
                || area1.y + area1.height <= area2.y
                || area2.y + area2.height <= area1.y;

            assert!(no_overlap, "Panes {} and {} should not overlap", i, j);
        }
    }
}