dioxus-tabular 0.3.0

Type-safe and composable table framework for Dioxus
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
//! Tests for ColumnContext usage patterns (simulating real app usage)

use crate::test_suite::test_hook;
use crate::{ColumnContext, Row, Sort, SortDirection, SortGesture, TableColumn, TableContext};
use dioxus::prelude::*;

// Test helper types for ColumnContext testing
#[derive(Clone, Copy, PartialEq)]
enum ColumnAction {
    Sort(SortGesture),
    SwapWith(usize),
    Hide,
    Show(Option<usize>),
    MoveTo(usize),
}

#[derive(Clone, Copy, PartialEq)]
enum ColumnKind {
    Name,
    Age,
    Priority,
}

#[derive(Clone, PartialEq)]
struct TestColumn {
    kind: ColumnKind,
    trigger: Signal<Option<ColumnAction>>,
}

impl TestColumn {
    fn name(trigger: Signal<Option<ColumnAction>>) -> Self {
        Self {
            kind: ColumnKind::Name,
            trigger,
        }
    }

    fn age(trigger: Signal<Option<ColumnAction>>) -> Self {
        Self {
            kind: ColumnKind::Age,
            trigger,
        }
    }

    fn priority(trigger: Signal<Option<ColumnAction>>) -> Self {
        Self {
            kind: ColumnKind::Priority,
            trigger,
        }
    }
}

impl TableColumn<TestPerson> for TestColumn {
    fn column_name(&self) -> String {
        match self.kind {
            ColumnKind::Name => "Name".to_string(),
            ColumnKind::Age => "Age".to_string(),
            ColumnKind::Priority => "Priority".to_string(),
        }
    }

    fn render_header(&self, context: ColumnContext, attributes: Vec<Attribute>) -> Element {
        // Simulate real app pattern: use_effect triggered by signal changes
        let trigger = self.trigger;
        let kind = self.kind;
        use_effect(move || {
            if let Some(action) = trigger.read().as_ref() {
                match action {
                    ColumnAction::Sort(gesture) => context.request_sort(*gesture),
                    ColumnAction::SwapWith(other) => context.swap_with(*other),
                    ColumnAction::Hide => context.hide(),
                    ColumnAction::Show(at) => context.show(*at),
                    ColumnAction::MoveTo(pos) => context.move_to(*pos),
                }
            }
        });
        let name = match kind {
            ColumnKind::Name => "Name",
            ColumnKind::Age => "Age",
            ColumnKind::Priority => "Priority",
        };
        rsx! {
            th { ..attributes,"{name}" }
        }
    }

    fn render_cell(
        &self,
        _context: ColumnContext,
        row: &TestPerson,
        _attributes: Vec<Attribute>,
    ) -> Element {
        rsx! {
            td { "{row.key().into()}" }
        }
    }

    fn compare(&self, a: &TestPerson, b: &TestPerson) -> std::cmp::Ordering {
        match self.kind {
            ColumnKind::Name => a.name.cmp(&b.name),
            ColumnKind::Age => a.age.cmp(&b.age),
            ColumnKind::Priority => std::cmp::Ordering::Equal,
        }
    }
}

// Test data
#[derive(Debug, Clone, PartialEq)]
struct TestPerson {
    name: String,
    age: u32,
}

impl Row for TestPerson {
    fn key(&self) -> impl Into<String> {
        format!("{}_{}", self.name, self.age)
    }
}

#[test]
fn test_column_context_swap_and_sort() {
    // Test that column reordering (via ColumnContext) doesn't affect sorting
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);

            let context = TableContext::use_table_context((col_name, col_age));
            let rows = use_signal(|| {
                vec![
                    TestPerson {
                        name: "Charlie".to_string(),
                        age: 35,
                    },
                    TestPerson {
                        name: "Bob".to_string(),
                        age: 25,
                    },
                    TestPerson {
                        name: "Alice".to_string(),
                        age: 30,
                    },
                ]
            });

            (context, rows, trigger_name, trigger_age)
        },
        |(context, rows, mut trigger_name, _trigger_age), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Trigger actions via ColumnContext (simulates onclick)
                trigger_name.set(Some(ColumnAction::SwapWith(1))); // Swap Name with Age
                trigger_name.set(Some(ColumnAction::Sort(SortGesture::AddFirst(Sort {
                    direction: SortDirection::Ascending,
                })))); // Sort by Name (original column 0)
            }
            1 => {
                // Verify results after use_effect completes
                let sorted_names: Vec<String> = context
                    .rows(rows.into())
                    .map(|row_data| row_data.rows.read()[row_data.index].name.clone())
                    .collect();

                assert_eq!(
                    sorted_names,
                    vec![
                        "Alice".to_string(),
                        "Bob".to_string(),
                        "Charlie".to_string()
                    ],
                    "After swap via ColumnContext, sorting by Name column still works correctly"
                );
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}

#[test]
fn test_column_context_hide() {
    // Test hiding a column via ColumnContext
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);

            let context = TableContext::use_table_context((col_name, col_age));

            (context, trigger_name, trigger_age)
        },
        |(context, mut trigger_name, _trigger_age), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Initially, both columns should be visible
                let initial_headers: Vec<_> = context.headers().collect();
                assert_eq!(initial_headers.len(), 2, "Initially should have 2 columns");

                // Hide Name column via ColumnContext
                trigger_name.set(Some(ColumnAction::Hide));
            }
            1 => {
                // Verify Name column is hidden
                let visible_headers: Vec<_> = context.headers().map(|h| h.key()).collect();
                assert_eq!(
                    visible_headers,
                    vec!["Age"],
                    "After hiding Name, should have 1 column"
                );
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}

#[test]
fn test_column_context_show() {
    // Test showing a hidden column via ColumnContext
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);

            let context = TableContext::use_table_context((col_name, col_age));

            // Hide Name column initially
            context.data.hide_column(0);

            (context, trigger_name, trigger_age)
        },
        |(context, mut trigger_name, _trigger_age), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Initially, Name should be hidden
                let initial_headers: Vec<_> = context.headers().collect();
                assert_eq!(
                    initial_headers.len(),
                    1,
                    "Initially should have 1 column (Age)"
                );

                // Show Name column via ColumnContext
                trigger_name.set(Some(ColumnAction::Show(None)));
            }
            1 => {
                // Verify Name column is now visible
                let visible_headers: Vec<_> = context.headers().map(|h| h.key()).collect();
                assert_eq!(
                    visible_headers,
                    vec!["Name", "Age"],
                    "After showing Name, should have 2 columns"
                );
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}

#[test]
fn test_column_context_move_to() {
    // Test moving a column via ColumnContext
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let trigger_priority = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);
            let col_priority = TestColumn::priority(trigger_priority);

            let context = TableContext::use_table_context((col_name, col_age, col_priority));

            (context, trigger_priority)
        },
        |(context, mut trigger_priority), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Initial order: Name, Age, Priority (indices 0, 1, 2)
                let initial_headers: Vec<_> = context.headers().collect();
                assert_eq!(initial_headers.len(), 3, "Should have 3 columns");

                // Move Priority (column 2) to position 0 via ColumnContext
                trigger_priority.set(Some(ColumnAction::MoveTo(0)));
            }
            1 => {
                // Verify Priority is now at position 0
                let headers: Vec<_> = context.headers().map(|h| h.key()).collect();
                assert_eq!(
                    headers,
                    vec!["Priority", "Name", "Age"],
                    "Should still have 3 columns"
                );
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}

#[test]
fn test_all_headers_includes_hidden() {
    // Test that all_headers() returns all columns including hidden ones
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);

            let context = TableContext::use_table_context((col_name, col_age));
            (context, trigger_age)
        },
        |(context, mut trigger_age), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Initially, both columns are visible
                let visible_headers: Vec<_> = context.headers().collect();
                let all_headers: Vec<_> = context.all_headers().collect();
                assert_eq!(visible_headers.len(), 2, "Initially 2 visible columns");
                assert_eq!(all_headers.len(), 2, "Initially 2 total columns");

                // Hide Age column
                trigger_age.set(Some(ColumnAction::Hide));
            }
            1 => {
                // After hiding Age, headers() should return 1, all_headers() should return 2
                let visible_headers: Vec<_> = context.headers().map(|h| h.key()).collect();
                let all_headers: Vec<_> = context.all_headers().map(|h| h.key()).collect();

                assert_eq!(
                    visible_headers,
                    vec!["Name"],
                    "After hiding Age, only 1 visible column"
                );
                assert_eq!(
                    all_headers,
                    vec!["Name", "Age"],
                    "After hiding Age, all_headers() still returns 2 columns"
                );

                // Verify we can still access the hidden column via all_headers()
                let age_header = context
                    .all_headers()
                    .find(|h| h.key() == "Age")
                    .expect("Age header should be present");
                let age_ctx = age_header.column_context();
                assert!(!age_ctx.is_visible(), "Age column should be hidden");
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}

#[test]
fn test_column_context_hidden_column_sort() {
    // Test that hidden columns can still be used for sorting
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);

            let context = TableContext::use_table_context((col_name, col_age));
            let rows = use_signal(|| {
                vec![
                    TestPerson {
                        name: "Charlie".to_string(),
                        age: 35,
                    },
                    TestPerson {
                        name: "Bob".to_string(),
                        age: 25,
                    },
                    TestPerson {
                        name: "Alice".to_string(),
                        age: 30,
                    },
                ]
            });

            (context, rows, trigger_name, trigger_age)
        },
        |(context, rows, _trigger_name, mut trigger_age), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Hide Age column and sort by it in one step
                trigger_age.set(Some(ColumnAction::Hide));
                trigger_age.set(Some(ColumnAction::Sort(SortGesture::AddFirst(Sort {
                    direction: SortDirection::Ascending,
                }))));
            }
            1 => {
                // Verify that sorting by hidden Age column works
                let sorted_names: Vec<String> = context
                    .rows(rows.into())
                    .map(|row_data| row_data.rows.read()[row_data.index].name.clone())
                    .collect();

                assert_eq!(
                    sorted_names,
                    vec![
                        "Bob".to_string(),     // age 25
                        "Alice".to_string(),   // age 30
                        "Charlie".to_string(), // age 35
                    ],
                    "Hidden Age column should still be sortable"
                );

                // Verify Age column is hidden
                let visible_headers: Vec<_> = context.headers().map(|h| h.key()).collect();
                assert_eq!(visible_headers, vec!["Name"], "Age column should be hidden, only Name visible");
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}

#[test]
fn test_column_context_swap_then_sort_hidden() {
    // Test complex scenario: swap columns, hide one, then sort by the hidden column
    test_hook(
        || {
            let trigger_name = use_signal(|| None);
            let trigger_age = use_signal(|| None);
            let col_name = TestColumn::name(trigger_name);
            let col_age = TestColumn::age(trigger_age);

            let context = TableContext::use_table_context((col_name, col_age));
            let rows = use_signal(|| {
                vec![
                    TestPerson {
                        name: "Charlie".to_string(),
                        age: 35,
                    },
                    TestPerson {
                        name: "Bob".to_string(),
                        age: 25,
                    },
                    TestPerson {
                        name: "Alice".to_string(),
                        age: 30,
                    },
                ]
            });

            (context, rows, trigger_name, trigger_age)
        },
        |(context, rows, mut trigger_name, _trigger_age), proxy| match proxy.generation {
            0 => {
                // Render headers to register use_effect
                for header in context.headers() {
                    let _ = header.render(vec![]);
                }

                // Swap, hide, and sort in one step
                trigger_name.set(Some(ColumnAction::SwapWith(1)));
                trigger_name.set(Some(ColumnAction::Hide));
                trigger_name.set(Some(ColumnAction::Sort(SortGesture::AddFirst(Sort {
                    direction: SortDirection::Ascending,
                }))));
            }
            1 => {
                // Verify that sorting by hidden Name column works
                let sorted_names: Vec<String> = context
                    .rows(rows.into())
                    .map(|row_data| row_data.rows.read()[row_data.index].name.clone())
                    .collect();

                assert_eq!(
                    sorted_names,
                    vec![
                        "Alice".to_string(),
                        "Bob".to_string(),
                        "Charlie".to_string(),
                    ],
                    "Hidden Name column should still be sortable"
                );

                // Verify only Age column is visible
                let visible_headers: Vec<_> = context.headers().collect();
                assert_eq!(
                    visible_headers.len(),
                    1,
                    "Should only have Age column visible"
                );
                assert_eq!(
                    visible_headers[0].key(),
                    "Age",
                    "Visible column should be Age (original index 1)"
                );
            }
            _ => panic!("Unexpected generation: {}", proxy.generation),
        },
        |proxy| {
            assert_eq!(proxy.generation, 1, "Expected exactly 1 generation");
        },
    );
}