nightshade-api 0.53.0

Procedural high level API for the nightshade game engine
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
//! A data table component with sorting, filtering, resizable columns, and
//! optional row virtualization.

use std::cmp::Ordering;

use leptos::html;
use leptos::prelude::*;
use wasm_bindgen::JsCast;

use crate::web::visible_range;

#[derive(Clone, Copy, PartialEq)]
enum SortDirection {
    Ascending,
    Descending,
}

fn compare_cells(left: &str, right: &str) -> Ordering {
    match (left.parse::<f64>(), right.parse::<f64>()) {
        (Ok(left), Ok(right)) => left.partial_cmp(&right).unwrap_or(Ordering::Equal),
        _ => left.cmp(right),
    }
}

fn compare_rows(left: &[String], right: &[String], sort: &[(usize, SortDirection)]) -> Ordering {
    for (column, direction) in sort {
        let left_cell = left.get(*column).map(String::as_str).unwrap_or("");
        let right_cell = right.get(*column).map(String::as_str).unwrap_or("");
        let ordering = compare_cells(left_cell, right_cell);
        let ordering = match direction {
            SortDirection::Ascending => ordering,
            SortDirection::Descending => ordering.reverse(),
        };
        if ordering != Ordering::Equal {
            return ordering;
        }
    }
    Ordering::Equal
}

/// A data table with multi-column sort (shift-click for additive sort),
/// text filter, column resize and show/hide, sticky header, pagination, inline
/// cell edit, and optional row virtualization. `rows` is a reactive signal of
/// row data; `on_row_click`, `on_cell_edit`, and `selected_row` wire up
/// selection and editing.
#[component]
pub fn Table(
    headers: Vec<String>,
    #[prop(into)] rows: Signal<Vec<Vec<String>>>,
    #[prop(optional)] sortable: bool,
    #[prop(optional)] filterable: bool,
    #[prop(optional)] resizable: bool,
    #[prop(optional)] virtualized: bool,
    #[prop(optional)] columns_toggle: bool,
    #[prop(optional)] page_size: Option<usize>,
    #[prop(default = 34.0)] row_height: f64,
    #[prop(default = 12)] overscan: usize,
    #[prop(optional)] height: Option<f64>,
    #[prop(optional)] on_row_click: Option<Callback<usize>>,
    #[prop(optional)] on_cell_edit: Option<Callback<(usize, usize, String)>>,
    #[prop(optional, into)] selected_row: Option<Signal<Option<usize>>>,
) -> impl IntoView {
    let column_count = headers.len();
    let header_labels = StoredValue::new(headers.clone());
    let sort = RwSignal::new(Vec::<(usize, SortDirection)>::new());
    let filter = RwSignal::new(String::new());
    let widths = RwSignal::new(vec![None::<f64>; column_count]);
    let visible = RwSignal::new(vec![true; column_count]);
    let columns_menu = RwSignal::new(false);
    let page = RwSignal::new(0usize);
    let editing = RwSignal::new(None::<(usize, usize)>);
    let draft = RwSignal::new(String::new());
    let scroll_top = RwSignal::new(0.0);
    let viewport_height = RwSignal::new(height.unwrap_or(360.0));
    let selected_row = selected_row.unwrap_or_else(|| Signal::derive(|| None));
    let wrap_ref = NodeRef::<html::Div>::new();
    let drag = StoredValue::new(None::<(usize, f64, f64)>);
    let paginated = page_size.is_some();
    let virtualized = virtualized && !paginated;

    Effect::new(move |_| {
        filter.track();
        page.set(0);
    });

    let cell_input = NodeRef::<html::Input>::new();
    Effect::new(move |_| {
        if editing.get().is_some()
            && let Some(input) = cell_input.get()
        {
            let _ = input.focus();
        }
    });

    let is_visible =
        move |column: usize| visible.with(|list| list.get(column).copied().unwrap_or(true));

    let toggle_sort = move |column: usize, additive: bool| {
        sort.update(|stack| {
            let existing = stack.iter().position(|(active, _)| *active == column);
            if additive {
                match existing {
                    Some(index) => match stack[index].1 {
                        SortDirection::Ascending => {
                            stack[index].1 = SortDirection::Descending;
                        }
                        SortDirection::Descending => {
                            stack.remove(index);
                        }
                    },
                    None => stack.push((column, SortDirection::Ascending)),
                }
            } else {
                *stack = match existing {
                    Some(index) if stack.len() == 1 => match stack[index].1 {
                        SortDirection::Ascending => vec![(column, SortDirection::Descending)],
                        SortDirection::Descending => Vec::new(),
                    },
                    _ => vec![(column, SortDirection::Ascending)],
                };
            }
        });
    };

    let processed = Memo::new(move |_| {
        let needle = filter.get().to_lowercase();
        let mut data = rows
            .get()
            .into_iter()
            .enumerate()
            .filter(|(_, row)| {
                needle.is_empty() || row.iter().any(|cell| cell.to_lowercase().contains(&needle))
            })
            .collect::<Vec<(usize, Vec<String>)>>();
        let sort = sort.get();
        if !sort.is_empty() {
            data.sort_by(|(_, left), (_, right)| compare_rows(left, right, &sort));
        }
        data
    });

    let page_count = move || {
        let Some(size) = page_size else {
            return 1;
        };
        processed.with(|data| data.len()).div_ceil(size).max(1)
    };

    let on_pointermove = move |event: web_sys::PointerEvent| {
        if let Some((column, start_x, start_width)) = drag.get_value() {
            let delta = event.client_x() as f64 - start_x;
            let next = (start_width + delta).max(48.0);
            widths.update(|list| {
                if let Some(slot) = list.get_mut(column) {
                    *slot = Some(next);
                }
            });
        }
    };
    let on_pointerup = move |_event: web_sys::PointerEvent| drag.set_value(None);

    let header_cells = (0..column_count)
        .map(|index| {
            let label = header_labels.with_value(|list| list[index].clone());
            let indicator = move || {
                let stack = sort.get();
                match stack.iter().find(|(active, _)| *active == index) {
                    Some((_, SortDirection::Ascending)) => " \u{25b2}".to_string(),
                    Some((_, SortDirection::Descending)) => " \u{25bc}".to_string(),
                    None => String::new(),
                }
            };
            let rank = move || {
                let stack = sort.get();
                if stack.len() > 1
                    && let Some(position) = stack.iter().position(|(active, _)| *active == index)
                {
                    return format!("{}", position + 1);
                }
                String::new()
            };
            let aria_sort = move || {
                let stack = sort.get();
                match stack.iter().find(|(active, _)| *active == index) {
                    Some((_, SortDirection::Ascending)) => "ascending",
                    Some((_, SortDirection::Descending)) => "descending",
                    _ if sortable => "none",
                    _ => "",
                }
            };
            let on_click = move |event: web_sys::MouseEvent| {
                if sortable {
                    toggle_sort(index, event.shift_key());
                }
            };
            let on_grip_down = move |event: web_sys::PointerEvent| {
                event.stop_propagation();
                event.prevent_default();
                let start_width = widths.with_untracked(|list| list.get(index).copied().flatten());
                let start_width = start_width.unwrap_or_else(|| {
                    event
                        .target()
                        .and_then(|target| target.dyn_into::<web_sys::HtmlElement>().ok())
                        .and_then(|element| element.parent_element())
                        .map(|parent| parent.get_bounding_client_rect().width())
                        .unwrap_or(120.0)
                });
                drag.set_value(Some((index, event.client_x() as f64, start_width)));
                if let Some(element) = event
                    .target()
                    .and_then(|target| target.dyn_into::<web_sys::Element>().ok())
                {
                    let _ = element.set_pointer_capture(event.pointer_id());
                }
            };
            view! {
                <Show when=move || is_visible(index) fallback=|| ()>
                    <th
                        scope="col"
                        class="nightshade-th"
                        class:sortable=sortable
                        aria-sort=aria_sort
                        on:click=on_click
                    >
                        <span class="nightshade-th-label">{label.clone()}{indicator}</span>
                        <span class="nightshade-th-rank">{rank}</span>
                        {resizable
                            .then(|| {
                                view! {
                                    <span
                                        class="nightshade-th-grip"
                                        on:pointerdown=on_grip_down
                                        on:pointermove=on_pointermove
                                        on:pointerup=on_pointerup
                                        on:click=|event| event.stop_propagation()
                                    ></span>
                                }
                            })}
                    </th>
                </Show>
            }
        })
        .collect_view();

    let colgroup = move || {
        (0..column_count)
            .map(|index| {
                let width = widths.with(|list| list.get(index).copied().flatten());
                let style = width
                    .map(|value| format!("width:{value}px"))
                    .unwrap_or_default();
                view! {
                    <Show when=move || is_visible(index) fallback=|| ()>
                        <col style=style.clone() />
                    </Show>
                }
            })
            .collect_view()
    };

    let visible_range = move |total: usize| {
        if !virtualized {
            return (0usize, total);
        }
        visible_range(
            scroll_top.get(),
            viewport_height.get(),
            row_height,
            overscan,
            total,
        )
    };

    let render_cell = move |original_index: usize, column: usize, cell: String| {
        let editable = on_cell_edit.is_some();
        let is_editing = move || editing.get() == Some((original_index, column));
        let cell = StoredValue::new(cell);
        let start_edit = move |_: web_sys::MouseEvent| {
            if editable {
                draft.set(cell.get_value());
                editing.set(Some((original_index, column)));
            }
        };
        let commit = move || {
            if let Some(callback) = on_cell_edit {
                callback.run((original_index, column, draft.get_untracked()));
            }
            editing.set(None);
        };
        view! {
            <Show when=move || is_visible(column) fallback=|| ()>
                <td class:editable=editable on:dblclick=start_edit>
                    {move || {
                        if is_editing() {
                            view! {
                                <input
                                    node_ref=cell_input
                                    class="nightshade-cell-input"
                                    prop:value=move || draft.get()
                                    on:click=|event| event.stop_propagation()
                                    on:input=move |event| draft.set(event_target_value(&event))
                                    on:keydown=move |event| {
                                        match event.key().as_str() {
                                            "Enter" => {
                                                event.prevent_default();
                                                commit();
                                            }
                                            "Escape" => {
                                                event.prevent_default();
                                                editing.set(None);
                                            }
                                            _ => {}
                                        }
                                    }
                                    on:blur=move |_| commit()
                                />
                            }
                                .into_any()
                        } else {
                            view! { <span>{cell.get_value()}</span> }.into_any()
                        }
                    }}
                </td>
            </Show>
        }
    };

    let body = move || {
        let page = page.get();
        processed.with(|data| {
            let total = data.len();
            let (page_start, page_end) = if let Some(size) = page_size {
                let start = (page * size).min(total);
                let end = (start + size).min(total);
                (start, end)
            } else {
                (0, total)
            };
            let visible_total = page_end - page_start;
            let (start, end) = visible_range(visible_total);
            let top_pad = start as f64 * row_height;
            let bottom_pad = visible_total.saturating_sub(end) as f64 * row_height;
            let visible_rows = data[page_start..page_end]
                .iter()
                .skip(start)
                .take(end - start)
                .cloned()
                .map(|(original_index, row)| {
                    let is_selected = move || selected_row.get() == Some(original_index);
                    let on_click = move |_| {
                        if let Some(callback) = on_row_click {
                            callback.run(original_index);
                        }
                    };
                    let style = virtualized.then(|| format!("height:{row_height}px"));
                    let cells = row
                        .into_iter()
                        .enumerate()
                        .map(|(column, cell)| render_cell(original_index, column, cell))
                        .collect_view();
                    view! {
                        <tr
                            class:selected=is_selected
                            class:clickable=on_row_click.is_some()
                            style=style
                            aria-selected=move || is_selected().to_string()
                            on:click=on_click
                        >
                            {cells}
                        </tr>
                    }
                })
                .collect_view();
            let spacer = move |pixels: f64| {
                (pixels > 0.5).then(|| {
                view! {
                    <tr class="nightshade-spacer-row" aria-hidden="true">
                        <td colspan=column_count style=format!("height:{pixels}px;padding:0")></td>
                    </tr>
                }
            })
            };
            view! {
                {spacer(top_pad)}
                {visible_rows}
                {spacer(bottom_pad)}
            }
        })
    };

    let on_scroll = move |event: web_sys::Event| {
        if let Some(element) = event
            .target()
            .and_then(|target| target.dyn_into::<web_sys::HtmlElement>().ok())
        {
            scroll_top.set(element.scroll_top() as f64);
            viewport_height.set(element.client_height() as f64);
        }
    };

    Effect::new(move |_| {
        if let Some(element) = wrap_ref.get() {
            viewport_height.set(element.client_height() as f64);
        }
    });

    let wrap_style = height.map(|value| format!("max-height:{value}px;overflow:auto"));

    view! {
        <div class="nightshade-table-shell">
            <div class="nightshade-table-toolbar">
                {filterable
                    .then(|| {
                        view! {
                            <input
                                class="nightshade-table-filter"
                                type="search"
                                placeholder="Filter rows…"
                                prop:value=move || filter.get()
                                on:input=move |event| filter.set(event_target_value(&event))
                            />
                        }
                    })}
                {columns_toggle
                    .then(|| {
                        view! {
                            <div class="nightshade-table-columns">
                                <button
                                    class="nightshade-button"
                                    on:click=move |_| columns_menu.update(|open| *open = !*open)
                                >
                                    "Columns"
                                </button>
                                <Show when=move || columns_menu.get() fallback=|| ()>
                                    <div class="nightshade-table-columns-menu">
                                        {(0..column_count)
                                            .map(|index| {
                                                let label = header_labels
                                                    .with_value(|list| list[index].clone());
                                                view! {
                                                    <label class="nightshade-table-column-row">
                                                        <input
                                                            type="checkbox"
                                                            prop:checked=move || is_visible(index)
                                                            on:change=move |_| {
                                                                visible
                                                                    .update(|list| {
                                                                        if let Some(slot) = list.get_mut(index) {
                                                                            *slot = !*slot;
                                                                        }
                                                                    })
                                                            }
                                                        />
                                                        {label}
                                                    </label>
                                                }
                                            })
                                            .collect_view()}
                                    </div>
                                </Show>
                            </div>
                        }
                    })}
            </div>
            <div
                class="nightshade-table-wrap"
                class:sticky=virtualized || height.is_some()
                node_ref=wrap_ref
                style=wrap_style
                on:scroll=on_scroll
            >
                <table class="nightshade-table">
                    <colgroup>{colgroup}</colgroup>
                    <thead>
                        <tr>{header_cells}</tr>
                    </thead>
                    <tbody>{body}</tbody>
                </table>
            </div>
            {paginated
                .then(|| {
                    view! {
                        <div class="nightshade-table-pager">
                            <button
                                class="nightshade-button"
                                disabled=move || page.get() == 0
                                on:click=move |_| page.update(|value| *value = value.saturating_sub(1))
                            >
                                "Prev"
                            </button>
                            <span class="nightshade-table-page">
                                {move || format!("Page {} / {}", page.get() + 1, page_count())}
                            </span>
                            <button
                                class="nightshade-button"
                                disabled=move || page.get() + 1 >= page_count()
                                on:click=move |_| {
                                    let last = page_count() - 1;
                                    page.update(|value| *value = (*value + 1).min(last))
                                }
                            >
                                "Next"
                            </button>
                        </div>
                    }
                })}
        </div>
    }
}

#[cfg(test)]
mod tests {
    use super::{SortDirection, compare_cells, compare_rows};
    use std::cmp::Ordering;

    #[test]
    fn numeric_cells_compare_by_value_not_lexically() {
        assert_eq!(compare_cells("9", "10"), Ordering::Less);
        assert_eq!(compare_cells("100", "20"), Ordering::Greater);
    }

    #[test]
    fn non_numeric_cells_compare_lexically() {
        assert_eq!(compare_cells("alpha", "beta"), Ordering::Less);
        assert_eq!(compare_cells("zeta", "alpha"), Ordering::Greater);
    }

    #[test]
    fn multi_column_sort_breaks_ties_with_secondary_key() {
        let left = vec!["group".to_string(), "1".to_string()];
        let right = vec!["group".to_string(), "2".to_string()];
        let sort = vec![
            (0, SortDirection::Ascending),
            (1, SortDirection::Descending),
        ];
        assert_eq!(compare_rows(&left, &right, &sort), Ordering::Greater);
    }
}