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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
//! List: virtualized, selectable, keyboard+mouse vertical list.
//!
//! Cycle-7 hardening: VARIABLE-HEIGHT items (per-item height callback,
//! prefix-sum windowing — offsets are CONTENT CELL ROWS, item lookup is
//! a binary search), STICKY SELECTION BY KEY (`key_fn` +
//! `selection_key`: rebuilds re-find the selected key's new index, so
//! data mutations keep the same LOGICAL item selected), and
//! `scroll_to` (a command signal: set `Some(index)`, the list scrolls
//! it into view and consumes the request).
//!
//! Variable-height v1 honesty: an item's extra rows reserve SPACE (for
//! spacing/grouping); the label renders on the item's first row only —
//! wrapped multi-row item CONTENT is a later decision.
//!
//! ```
//! use abstracttui::base::Size;
//! use abstracttui::reactive::create_root;
//! use abstracttui::ui::{BufferCanvas, Element, UiTree};
//! use abstracttui::widgets::List;
//!
//! let mut tree = UiTree::new(Size::new(12, 3));
//! let (root, ()) = create_root(|cx| {
//! let sel_key = cx.signal(String::from("beta"));
//! let view = Element::new()
//! .child(
//! List::of(["alpha", "beta", "gamma"])
//! .key_fn(|_, item| item.to_string())
//! .selection_key(sel_key) // sticky across data changes
//! .view(cx),
//! )
//! .build();
//! tree.mount(cx, view);
//! });
//! let mut canvas = BufferCanvas::new(Size::new(12, 3));
//! tree.draw(&mut canvas);
//! assert!(canvas.row_text(1).contains("beta"));
//! root.dispose();
//! ```
//!
//! OWNER: REACT.
use std::cell::RefCell;
use std::rc::Rc;
use crate::layout::{Dimension, Style as LayoutStyle};
use crate::reactive::{Scope, Signal};
use crate::render::Style;
use crate::theme::TokenSet;
use crate::ui::{dyn_view, Element, EventCtx, Key, MouseButton, MouseKind, Phase, UiEvent};
type HeightFn = Box<dyn Fn(usize, &str) -> i32>;
type KeyFn = Box<dyn Fn(usize, &str) -> String>;
pub struct List {
items: Vec<String>,
selection: Option<Signal<usize>>,
selection_key: Option<Signal<String>>,
key_fn: Option<KeyFn>,
heights: Option<HeightFn>,
scroll_to: Option<Signal<Option<usize>>>,
focused: Option<Signal<bool>>,
layout: Option<LayoutStyle>,
on_select: Option<Box<dyn FnMut(usize)>>,
}
impl List {
/// Ergonomic constructor: anything iterable into strings —
/// `List::of(["a", "b"])`, an iterator chain, string slices.
/// (`new` keeps the plain `Vec<String>` signature so existing
/// `.collect()` call sites stay inferable.)
pub fn of<I, S>(items: I) -> List
where
I: IntoIterator<Item = S>,
S: Into<String>,
{
List::new(items.into_iter().map(Into::into).collect())
}
pub fn new(items: Vec<String>) -> List {
List {
items,
selection: None,
selection_key: None,
key_fn: None,
heights: None,
scroll_to: None,
focused: None,
layout: None,
on_select: None,
}
}
/// Bind an external selection signal (index); default is internal.
pub fn selection(mut self, selection: Signal<usize>) -> List {
self.selection = Some(selection);
self
}
/// Stable item identity for sticky selection: with `selection_key`
/// bound, rebuilds re-find the key's CURRENT index (data mutations
/// keep the logical item selected) and selecting writes the key.
pub fn key_fn(mut self, f: impl Fn(usize, &str) -> String + 'static) -> List {
self.key_fn = Some(Box::new(f));
self
}
/// The selected item's KEY (see [`List::key_fn`]).
pub fn selection_key(mut self, key: Signal<String>) -> List {
self.selection_key = Some(key);
self
}
/// Per-item height in cell rows (min 1). Enables variable-height
/// virtualization; without it every item is one row.
pub fn item_heights(mut self, f: impl Fn(usize, &str) -> i32 + 'static) -> List {
self.heights = Some(Box::new(f));
self
}
/// Command signal: set `Some(index)` to scroll that item into view;
/// the list consumes the request (resets to `None`).
pub fn scroll_to(mut self, request: Signal<Option<usize>>) -> List {
self.scroll_to = Some(request);
self
}
/// Bind an external focus signal (D4-2): true while the list holds
/// keyboard focus — panes wire their stroke color to it (§3.2).
pub fn focus_signal(mut self, focused: Signal<bool>) -> List {
self.focused = Some(focused);
self
}
pub fn layout(mut self, layout: LayoutStyle) -> List {
self.layout = Some(layout);
self
}
pub fn on_select(mut self, f: impl FnMut(usize) + 'static) -> List {
self.on_select = Some(Box::new(f));
self
}
/// Canonical one-call build (cycle 8): tokens resolve from the
/// app's THEME CONTEXT (a tracked read — building inside a
/// `dyn_view` re-renders on theme switch) and the finished `View`
/// comes back ready for `.child(..)`. Use `element(cx, &tokens)`
/// when you need explicit theming or extra Element customization.
pub fn view(self, cx: Scope) -> crate::ui::View {
let t = crate::widgets::theme_tokens(cx);
self.element(cx, &t).build()
}
pub fn element(self, cx: Scope, t: &TokenSet) -> Element {
let text_fg = t.text;
let ground = t.surface;
let sel_bg = t.selection_bg;
let sel_fg = t.selection_fg;
let track = t.border;
let thumb = t.text_muted;
let items = Rc::new(self.items);
let len = items.len();
// Prefix sums over item heights: prefix[i] = first content row
// of item i; prefix[len] = total rows. Uniform lists get the
// identity prefix — ONE windowing code path.
let prefix: Rc<Vec<i32>> = Rc::new({
let mut out = Vec::with_capacity(len + 1);
let mut acc = 0i32;
out.push(0);
for (i, item) in items.iter().enumerate() {
let h = self
.heights
.as_ref()
.map(|f| f(i, item).max(1))
.unwrap_or(1);
acc += h;
out.push(acc);
}
out
});
let total_rows = *prefix.last().unwrap_or(&0);
let selection = self.selection.unwrap_or_else(|| cx.signal(0usize));
// Sticky selection: the KEY re-finds its index at build time —
// this is what survives data mutations (each mutation rebuilds
// through the caller's Dyn).
let keys: Option<Rc<Vec<String>>> = self.key_fn.map(|f| {
Rc::new(
items
.iter()
.enumerate()
.map(|(i, s)| f(i, s))
.collect::<Vec<_>>(),
)
});
if let (Some(key_sig), Some(keys)) = (self.selection_key, keys.as_ref()) {
let wanted = key_sig.get_untracked();
if let Some(idx) = keys.iter().position(|k| *k == wanted) {
if selection.get_untracked() != idx {
selection.set(idx);
}
}
}
let selection_key = self.selection_key;
let keys_for_select = keys.clone();
let offset = cx.signal(0i32); // first visible CONTENT ROW
let on_select: crate::widgets::SharedCallback<usize> =
Rc::new(RefCell::new(self.on_select));
let layout = self
.layout
.unwrap_or_else(|| LayoutStyle::default().grow(1.0));
let prefix_for_select = prefix.clone();
let select = {
let on_select = on_select.clone();
move |target: usize, view_h: i32| {
let target = target.min(len.saturating_sub(1));
if selection.get_untracked() != target {
selection.set(target);
if let (Some(key_sig), Some(keys)) = (selection_key, keys_for_select.as_ref()) {
if let Some(k) = keys.get(target) {
key_sig.set(k.clone());
}
}
if let Some(f) = on_select.borrow_mut().as_mut() {
f(target);
}
}
// ensure-visible on CONTENT ROWS (variable heights).
let top = prefix_for_select[target];
let bottom = prefix_for_select[target + 1];
offset.update(|o| {
if top < *o {
*o = top;
}
if view_h > 0 && bottom > *o + view_h {
*o = bottom - view_h;
}
*o = (*o).clamp(0, (total_rows - view_h.max(1)).max(0));
});
}
};
// scroll_to command signal: consume Some(idx) into an offset.
if let Some(request) = self.scroll_to {
let prefix_for_scroll = prefix.clone();
cx.effect_labeled("list-scroll-to", move || {
if let Some(idx) = request.get() {
let idx = idx.min(len.saturating_sub(1));
let top = prefix_for_scroll[idx];
offset.update(|o| {
*o = top.clamp(0, (total_rows - 1).max(0));
});
request.set(None); // consumed (one extra no-op run)
}
});
}
let prefix_for_handler = prefix.clone();
let handler = move |ctx: &mut EventCtx, ev: &UiEvent| {
let rect = ctx.current_rect();
let h = rect.h.max(1);
match ev {
UiEvent::Key(k) => {
let cur = selection.get_untracked();
let page = (h as usize).max(1);
let target = match k.key {
Key::Up => cur.saturating_sub(1),
Key::Down => cur + 1,
Key::PageUp => cur.saturating_sub(page),
Key::PageDown => cur + page,
Key::Home => 0,
Key::End => len.saturating_sub(1),
_ => return,
};
select(target, h);
ctx.stop_propagation();
}
UiEvent::Mouse(m) => match m.kind {
MouseKind::ScrollUp | MouseKind::ScrollDown => {
let delta = if m.kind == MouseKind::ScrollUp { -3 } else { 3 };
offset.update(|o| {
*o = (*o + delta).clamp(0, (total_rows - h).max(0));
});
ctx.stop_propagation();
}
MouseKind::Down(MouseButton::Left) => {
// Content row -> item index (binary search on
// the prefix; the row belongs to the item whose
// span contains it).
let row = (m.pos.y - rect.y) + offset.get_untracked();
if row >= 0 && row < total_rows {
let idx = prefix_for_handler
.partition_point(|&p| p <= row)
.saturating_sub(1);
if idx < len {
select(idx, h);
}
}
ctx.stop_propagation();
}
_ => {}
},
_ => {}
}
};
let mut el = Element::new()
.style(layout)
.role(crate::ui::Role::List)
.access_value(move || {
format!("{} items, selected {}", len, selection.get_untracked() + 1)
})
.focusable();
if let Some(focused) = self.focused {
el = el.focus_signal(focused);
}
let prefix_for_draw = prefix;
el.on(Phase::Bubble, handler).child(dyn_view(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
move || {
let sel = selection.get();
let first_row = offset.get().max(0);
let items = items.clone();
let prefix = prefix_for_draw.clone();
Element::new()
.style(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
)
.draw(move |canvas, rect| {
if rect.is_empty() || items.is_empty() {
return;
}
let base = Style::new().fg(text_fg).bg(ground);
canvas.fill_styled(rect, ' ', &base);
let total = *prefix.last().unwrap_or(&0);
let show_bar = total > rect.h;
let text_w = if show_bar { rect.w - 1 } else { rect.w };
// Virtualization: first visible item by
// binary search, walk until off-screen.
let mut idx = prefix
.partition_point(|&p| p <= first_row)
.saturating_sub(1);
while idx < items.len() {
let top = prefix[idx] - first_row;
if top >= rect.h {
break;
}
let item_h = prefix[idx + 1] - prefix[idx];
let selected = idx == sel;
let style = if selected {
Style::new().fg(sel_fg).bg(sel_bg)
} else {
base
};
if selected {
// The whole item area wears the pair.
for r in 0..item_h {
let y = rect.y + top + r;
if y >= rect.y && y < rect.bottom() {
canvas.fill_styled(
crate::base::Rect::new(rect.x, y, text_w, 1),
' ',
&style,
);
}
}
}
let y = rect.y + top;
if y >= rect.y && y < rect.bottom() {
let line =
crate::text::truncate_ellipsis(&items[idx], text_w.max(0));
canvas.print_styled(
crate::base::Point::new(rect.x, y),
&line,
&style,
);
}
idx += 1;
}
if show_bar {
draw_scrollbar(canvas, rect, first_row, total, track, thumb, ground);
}
})
.build()
},
))
}
}
/// Token-styled vertical scrollbar in the rightmost column. `first` and
/// `total` are content ROWS (shared by List/Table; Table passes item
/// counts, which are rows there).
pub(crate) fn draw_scrollbar(
canvas: &mut dyn crate::ui::StyledCanvas,
rect: crate::base::Rect,
first: i32,
total: i32,
track: crate::base::Rgba,
thumb: crate::base::Rgba,
ground: crate::base::Rgba,
) {
let x = rect.right() - 1;
let h = rect.h.max(1);
let track_style = Style::new().fg(track).bg(ground);
for y in rect.y..rect.bottom() {
canvas.print_styled(crate::base::Point::new(x, y), "│", &track_style);
}
let thumb_h = ((h * h) / total.max(1)).clamp(1, h);
let denom = (total - h).max(1);
let thumb_y = rect.y + ((first.min(denom) * (h - thumb_h)) / denom).max(0);
let thumb_style = Style::new().fg(thumb).bg(ground);
for y in thumb_y..(thumb_y + thumb_h).min(rect.bottom()) {
canvas.print_styled(crate::base::Point::new(x, y), "┃", &thumb_style);
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::base::Size;
use crate::theme::default_theme;
use crate::widgets::itest_util::{key, mount_widget, mouse, render};
fn rows(canvas: &crate::ui::BufferCanvas, n: i32) -> Vec<String> {
(0..n).map(|y| canvas.row_text(y)).collect()
}
#[test]
fn keyboard_selection_scrolls_window_and_fires_on_select() {
let t = default_theme().tokens;
let picked: Rc<RefCell<Vec<usize>>> = Rc::new(RefCell::new(Vec::new()));
let p = picked.clone();
let (_root, mut tree) = mount_widget(Size::new(12, 3), |cx| {
Element::new()
.style(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
)
.child(
List::of((0..8).map(|i| format!("item {i}")))
.on_select(move |i| p.borrow_mut().push(i))
.element(cx, &t)
.build(),
)
.build()
});
key(&mut tree, Key::Tab);
for _ in 0..4 {
key(&mut tree, Key::Down);
}
crate::reactive::flush_effects();
tree.layout();
let canvas = render(&mut tree, Size::new(12, 3));
// Selection 4 scrolled into view (rows 2..5 visible).
assert!(
rows(&canvas, 3).iter().any(|r| r.contains("item 4")),
"{:?}",
rows(&canvas, 3)
);
assert_eq!(*picked.borrow(), vec![1, 2, 3, 4]);
}
#[test]
fn click_selects_by_visible_row_and_wheel_scrolls() {
let t = default_theme().tokens;
let mut sel_probe = None;
let (_root, mut tree) = mount_widget(Size::new(12, 4), |cx| {
let sel = cx.signal(0usize);
sel_probe = Some(sel);
Element::new()
.style(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
)
.child(
List::of((0..20).map(|i| format!("row {i}")))
.selection(sel)
.element(cx, &t)
.build(),
)
.build()
});
let sel = sel_probe.unwrap();
mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 2);
assert_eq!(sel.get_untracked(), 2);
mouse(&mut tree, MouseKind::ScrollDown, 2, 2);
crate::reactive::flush_effects();
tree.layout();
let canvas = render(&mut tree, Size::new(12, 4));
assert!(
canvas.row_text(0).contains("row 3"),
"{:?}",
canvas.row_text(0)
);
}
#[test]
fn selection_key_survives_data_mutation_rebuild() {
// STICKY SELECTION (cycle 7): the key signal re-finds its item's
// NEW index after items shift — a rebuild with an inserted row
// keeps the same logical item selected.
let t = default_theme().tokens;
let mut probes = None;
let (_root, mut tree) = mount_widget(Size::new(14, 5), |cx| {
let data = cx.signal(vec!["alpha".to_string(), "beta".into(), "gamma".into()]);
let sel_key = cx.signal(String::from("beta"));
let sel_ix = cx.signal(0usize);
probes = Some((data, sel_key, sel_ix));
let tokens = t;
Element::new()
.style(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
)
.child(crate::ui::dyn_view_scoped(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
move |gen_cx| {
List::new(data.get())
.key_fn(|_, s| s.to_string())
.selection_key(sel_key)
.selection(sel_ix)
.element(gen_cx, &tokens)
.build()
},
))
.build()
});
let (data, sel_key, sel_ix) = probes.unwrap();
crate::reactive::flush_effects();
assert_eq!(sel_ix.get_untracked(), 1, "key 'beta' resolved to index 1");
// Mutate: insert two rows BEFORE beta -> its index becomes 3.
data.update(|v| {
v.insert(0, "zero".into());
v.insert(1, "one".into());
});
crate::reactive::flush_effects();
assert_eq!(
sel_ix.get_untracked(),
3,
"sticky: beta re-found after mutation"
);
assert_eq!(sel_key.get_untracked(), "beta");
// And selecting a different row updates the key.
key(&mut tree, Key::Tab);
key(&mut tree, Key::Down);
crate::reactive::flush_effects();
assert_eq!(sel_key.get_untracked(), "gamma");
}
#[test]
fn variable_heights_window_by_content_rows_and_click_maps_rows_to_items() {
let t = default_theme().tokens;
let mut sel_probe = None;
let (_root, mut tree) = mount_widget(Size::new(14, 4), |cx| {
let sel = cx.signal(0usize);
sel_probe = Some(sel);
Element::new()
.style(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
)
.child(
List::of((0..6).map(|i| format!("it {i}")))
.item_heights(|i, _| if i % 2 == 0 { 2 } else { 1 })
.selection(sel)
.element(cx, &t)
.build(),
)
.build()
});
let sel = sel_probe.unwrap();
tree.layout();
let canvas = render(&mut tree, Size::new(14, 4));
// it0 occupies rows 0-1 (h=2), it1 row 2, it2 rows 3+.
assert!(canvas.row_text(0).contains("it 0"));
assert_eq!(
canvas.row_text(1).trim(),
"│",
"spacer row of the 2-tall item (+bar)"
);
assert!(canvas.row_text(2).contains("it 1"));
// Clicking the SECOND row of it0 still selects item 0.
mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 1);
assert_eq!(sel.get_untracked(), 0);
// Clicking row 2 selects item 1 (row->item binary search).
mouse(&mut tree, MouseKind::Down(MouseButton::Left), 2, 2);
assert_eq!(sel.get_untracked(), 1);
}
#[test]
fn scroll_to_command_scrolls_and_consumes() {
let t = default_theme().tokens;
let mut probe = None;
let (_root, mut tree) = mount_widget(Size::new(12, 3), |cx| {
let req = cx.signal(None::<usize>);
probe = Some(req);
Element::new()
.style(
LayoutStyle::default()
.width(Dimension::Percent(1.0))
.height(Dimension::Percent(1.0)),
)
.child(
List::of((0..30).map(|i| format!("row {i}")))
.scroll_to(req)
.element(cx, &t)
.build(),
)
.build()
});
let req = probe.unwrap();
req.set(Some(20));
crate::reactive::flush_effects();
tree.layout();
let canvas = render(&mut tree, Size::new(12, 3));
assert!(
canvas.row_text(0).contains("row 20"),
"{:?}",
canvas.row_text(0)
);
assert_eq!(req.get_untracked(), None, "request consumed");
}
}