panes 0.19.0

Renderer-agnostic layout engine with declarative ergonomics
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

#![allow(clippy::unwrap_used, clippy::panic)]
use std::sync::Arc;

use panes::runtime::LayoutRuntime;
use panes::{CardSpan, GridColumnMode, Layout, MutationError, PaneError, StrategyKind};

fn kinds(n: usize) -> Vec<Arc<str>> {
    (0..n).map(|i| Arc::from(format!("p{i}"))).collect()
}

fn dashboard_runtime(n: usize, columns: usize) -> LayoutRuntime {
    let k = kinds(n);
    let spans: Arc<[CardSpan]> = vec![CardSpan::Columns(1); n].into();
    LayoutRuntime::from_strategy(
        StrategyKind::Dashboard {
            columns: GridColumnMode::Fixed(columns),
            gap: 0.0,
            spans,
            auto_rows: false,
        },
        &k,
    )
    .unwrap()
}

#[test]
fn set_span_columns() {
    let mut rt = dashboard_runtime(2, 4);
    let p0 = rt.sequence().get(0).unwrap();

    rt.set_card_span(p0, CardSpan::Columns(2)).unwrap();

    let frame = rt.resolve(400.0, 200.0).unwrap();
    let r0 = frame.layout().get(p0).unwrap();
    let p1 = rt.sequence().get(1).unwrap();
    let r1 = frame.layout().get(p1).unwrap();
    assert!(
        r0.w > r1.w,
        "span-2 card should be wider than span-1: {} vs {}",
        r0.w,
        r1.w
    );
}

#[test]
fn set_span_full_width() {
    let mut rt = dashboard_runtime(2, 4);
    let p0 = rt.sequence().get(0).unwrap();

    rt.set_card_span(p0, CardSpan::FullWidth).unwrap();

    let frame = rt.resolve(400.0, 200.0).unwrap();
    let r0 = frame.layout().get(p0).unwrap();
    assert!(
        (r0.w - 400.0).abs() < 1.0,
        "full-width card should span viewport: got {}",
        r0.w
    );
}

#[test]
fn round_trip_span_change() {
    let mut rt = dashboard_runtime(4, 4);
    let p1 = rt.sequence().get(1).unwrap();

    rt.set_card_span(p1, CardSpan::Columns(2)).unwrap();

    let frame = rt.resolve(400.0, 200.0).unwrap();
    let r1 = frame.layout().get(p1).unwrap();
    // 4 columns, 0 gap → each column is 100px. Span 2 → ~200px.
    assert!(
        (r1.w - 200.0).abs() < 2.0,
        "expected ~200px for span-2, got {}",
        r1.w
    );
}

#[test]
fn error_on_non_dashboard() {
    let mut rt = Layout::master_stack(["a", "b", "c"])
        .into_runtime()
        .unwrap();
    let p0 = rt.sequence().get(0).unwrap();

    let err = rt.set_card_span(p0, CardSpan::Columns(2)).unwrap_err();
    assert!(
        matches!(
            err,
            PaneError::InvalidMutation(MutationError::SpanNotSupported)
        ),
        "expected SpanNotSupported, got {err}"
    );
}

#[test]
fn error_on_no_strategy() {
    let mut tree = panes::LayoutTree::new();
    let (_, n0) = tree.add_panel("a", panes::grow(1.0)).unwrap();
    let root = tree.add_row(0.0, vec![n0]).unwrap();
    tree.set_root(root);
    let mut rt = LayoutRuntime::new(tree);

    let pid = rt.tree().panels_by_kind("a")[0];
    let err = rt.set_card_span(pid, CardSpan::Columns(2)).unwrap_err();
    assert!(
        matches!(err, PaneError::InvalidMutation(MutationError::NoStrategy)),
        "expected NoStrategy, got {err}"
    );
}

#[test]
fn auto_fill_set_span() {
    let k = kinds(3);
    let spans: Arc<[CardSpan]> = vec![CardSpan::Columns(1); 3].into();
    let mut rt = LayoutRuntime::from_strategy(
        StrategyKind::Dashboard {
            columns: GridColumnMode::AutoFill { min_width: 100.0 },
            gap: 0.0,
            spans,
            auto_rows: false,
        },
        &k,
    )
    .unwrap();
    let p0 = rt.sequence().get(0).unwrap();

    rt.set_card_span(p0, CardSpan::Columns(2)).unwrap();

    // Verify strategy was updated
    match rt.strategy().unwrap() {
        StrategyKind::Dashboard {
            spans,
            columns: GridColumnMode::AutoFill { .. },
            ..
        } => {
            assert_eq!(spans[0], CardSpan::Columns(2));
        }
        other => panic!("expected Dashboard with AutoFill, got {other:?}"),
    }
}

#[test]
fn preserves_other_spans() {
    let k = kinds(3);
    let initial_spans: Arc<[CardSpan]> = vec![
        CardSpan::Columns(1),
        CardSpan::Columns(3),
        CardSpan::FullWidth,
    ]
    .into();
    let mut rt = LayoutRuntime::from_strategy(
        StrategyKind::Dashboard {
            columns: GridColumnMode::Fixed(4),
            gap: 0.0,
            spans: initial_spans,
            auto_rows: false,
        },
        &k,
    )
    .unwrap();
    let p0 = rt.sequence().get(0).unwrap();

    rt.set_card_span(p0, CardSpan::Columns(2)).unwrap();

    match rt.strategy().unwrap() {
        StrategyKind::Dashboard { spans, .. } => {
            assert_eq!(spans[0], CardSpan::Columns(2));
            assert_eq!(spans[1], CardSpan::Columns(3));
            assert_eq!(spans[2], CardSpan::FullWidth);
        }
        other => panic!("expected Dashboard, got {other:?}"),
    }
}