1//! A scrollable list of elements with uniform height, optimized for large lists.
2//! Rather than use the full taffy layout system, uniform_list simply measures
3//! the first element and then lays out all remaining elements in a line based on that
4//! measurement. This is much faster than the full layout system, but only works for
5//! elements with uniform height.
6
7use crate::{
8 AnyElement, App, AvailableSpace, Bounds, ContentMask, Element, ElementId, GlobalElementId,
9 Hitbox, InspectorElementId, InteractiveElement, Interactivity, IntoElement, IsZero, LayoutId,
10 ListSizingBehavior, Overflow, Pixels, Point, ScrollHandle, Size, StyleRefinement, Styled,
11 Window, point, size,
12};
13use smallvec::SmallVec;
14use std::{cell::RefCell, cmp, ops::Range, rc::Rc};
15
16use super::ListHorizontalSizingBehavior;
17
18/// uniform_list provides lazy rendering for a set of items that are of uniform height.
19/// When rendered into a container with overflow-y: hidden and a fixed (or max) height,
20/// uniform_list will only render the visible subset of items.
21#[track_caller]
22pub fn uniform_list<R>(
23 id: impl Into<ElementId>,
24 item_count: usize,
25 f: impl 'static + Fn(Range<usize>, &mut Window, &mut App) -> Vec<R>,
26) -> UniformList
27where
28 R: IntoElement,
29{
30 let id = id.into();
31 let mut base_style = StyleRefinement::default();
32 base_style.overflow.y = Some(Overflow::Scroll);
33
34 let render_range = move |range: Range<usize>, window: &mut Window, cx: &mut App| {
35 f(range, window, cx)
36 .into_iter()
37 .map(|component| component.into_any_element())
38 .collect()
39 };
40
41 UniformList {
42 item_count,
43 item_to_measure_index: 0,
44 render_items: Box::new(render_range),
45 decorations: Vec::new(),
46 interactivity: Interactivity {
47 element_id: Some(id),
48 base_style: Box::new(base_style),
49 ..Interactivity::new()
50 },
51 scroll_handle: None,
52 sizing_behavior: ListSizingBehavior::default(),
53 horizontal_sizing_behavior: ListHorizontalSizingBehavior::default(),
54 }
55}
56
57/// A list element for efficiently laying out and displaying a list of uniform-height elements.
58pub struct UniformList {
59 item_count: usize,
60 item_to_measure_index: usize,
61 render_items: Box<
62 dyn for<'a> Fn(Range<usize>, &'a mut Window, &'a mut App) -> SmallVec<[AnyElement; 64]>,
63 >,
64 decorations: Vec<Box<dyn UniformListDecoration>>,
65 interactivity: Interactivity,
66 scroll_handle: Option<UniformListScrollHandle>,
67 sizing_behavior: ListSizingBehavior,
68 horizontal_sizing_behavior: ListHorizontalSizingBehavior,
69}
70
71/// Frame state used by the [UniformList].
72pub struct UniformListFrameState {
73 items: SmallVec<[AnyElement; 32]>,
74 decorations: SmallVec<[AnyElement; 1]>,
75}
76
77/// A handle for controlling the scroll position of a uniform list.
78/// This should be stored in your view and passed to the uniform_list on each frame.
79#[derive(Clone, Debug, Default)]
80pub struct UniformListScrollHandle(pub Rc<RefCell<UniformListScrollState>>);
81
82/// Where to place the element scrolled to.
83#[derive(Clone, Copy, Debug, PartialEq, Eq)]
84pub enum ScrollStrategy {
85 /// Place the element at the top of the list's viewport.
86 Top,
87 /// Attempt to place the element in the middle of the list's viewport.
88 /// May not be possible if there's not enough list items above the item scrolled to:
89 /// in this case, the element will be placed at the closest possible position.
90 Center,
91}
92
93#[derive(Clone, Copy, Debug)]
94#[allow(missing_docs)]
95pub struct DeferredScrollToItem {
96 /// The item index to scroll to
97 pub item_index: usize,
98 /// The scroll strategy to use
99 pub strategy: ScrollStrategy,
100 /// The offset in number of items
101 pub offset: usize,
102}
103
104#[derive(Clone, Debug, Default)]
105#[allow(missing_docs)]
106pub struct UniformListScrollState {
107 pub base_handle: ScrollHandle,
108 pub deferred_scroll_to_item: Option<DeferredScrollToItem>,
109 /// Size of the item, captured during last layout.
110 pub last_item_size: Option<ItemSize>,
111 /// Whether the list was vertically flipped during last layout.
112 pub y_flipped: bool,
113}
114
115#[derive(Copy, Clone, Debug, Default)]
116/// The size of the item and its contents.
117pub struct ItemSize {
118 /// The size of the item.
119 pub item: Size<Pixels>,
120 /// The size of the item's contents, which may be larger than the item itself,
121 /// if the item was bounded by a parent element.
122 pub contents: Size<Pixels>,
123}
124
125impl UniformListScrollHandle {
126 /// Create a new scroll handle to bind to a uniform list.
127 pub fn new() -> Self {
128 Self(Rc::new(RefCell::new(UniformListScrollState {
129 base_handle: ScrollHandle::new(),
130 deferred_scroll_to_item: None,
131 last_item_size: None,
132 y_flipped: false,
133 })))
134 }
135
136 /// Scroll the list to the given item index.
137 pub fn scroll_to_item(&self, ix: usize, strategy: ScrollStrategy) {
138 self.0.borrow_mut().deferred_scroll_to_item = Some(DeferredScrollToItem {
139 item_index: ix,
140 strategy,
141 offset: 0,
142 });
143 }
144
145 /// Scroll the list to the given item index with an offset.
146 ///
147 /// For ScrollStrategy::Top, the item will be placed at the offset position from the top.
148 ///
149 /// For ScrollStrategy::Center, the item will be centered between offset and the last visible item.
150 pub fn scroll_to_item_with_offset(&self, ix: usize, strategy: ScrollStrategy, offset: usize) {
151 self.0.borrow_mut().deferred_scroll_to_item = Some(DeferredScrollToItem {
152 item_index: ix,
153 strategy,
154 offset,
155 });
156 }
157
158 /// Check if the list is flipped vertically.
159 pub fn y_flipped(&self) -> bool {
160 self.0.borrow().y_flipped
161 }
162
163 /// Get the index of the topmost visible child.
164 #[cfg(any(test, feature = "test-support"))]
165 pub fn logical_scroll_top_index(&self) -> usize {
166 let this = self.0.borrow();
167 this.deferred_scroll_to_item
168 .as_ref()
169 .map(|deferred| deferred.item_index)
170 .unwrap_or_else(|| this.base_handle.logical_scroll_top().0)
171 }
172
173 /// Checks if the list can be scrolled vertically.
174 pub fn is_scrollable(&self) -> bool {
175 if let Some(size) = self.0.borrow().last_item_size {
176 size.contents.height > size.item.height
177 } else {
178 false
179 }
180 }
181}
182
183impl Styled for UniformList {
184 fn style(&mut self) -> &mut StyleRefinement {
185 &mut self.interactivity.base_style
186 }
187}
188
189impl Element for UniformList {
190 type RequestLayoutState = UniformListFrameState;
191 type PrepaintState = Option<Hitbox>;
192
193 fn id(&self) -> Option<ElementId> {
194 self.interactivity.element_id.clone()
195 }
196
197 fn source_location(&self) -> Option<&'static core::panic::Location<'static>> {
198 None
199 }
200
201 fn request_layout(
202 &mut self,
203 global_id: Option<&GlobalElementId>,
204 inspector_id: Option<&InspectorElementId>,
205 window: &mut Window,
206 cx: &mut App,
207 ) -> (LayoutId, Self::RequestLayoutState) {
208 let max_items = self.item_count;
209 let item_size = self.measure_item(None, window, cx);
210 let layout_id = self.interactivity.request_layout(
211 global_id,
212 inspector_id,
213 window,
214 cx,
215 |style, window, cx| match self.sizing_behavior {
216 ListSizingBehavior::Infer => {
217 window.with_text_style(style.text_style().cloned(), |window| {
218 window.request_measured_layout(
219 style,
220 move |known_dimensions, available_space, _window, _cx| {
221 let desired_height = item_size.height * max_items;
222 let width = known_dimensions.width.unwrap_or(match available_space
223 .width
224 {
225 AvailableSpace::Definite(x) => x,
226 AvailableSpace::MinContent | AvailableSpace::MaxContent => {
227 item_size.width
228 }
229 });
230 let height = match available_space.height {
231 AvailableSpace::Definite(height) => desired_height.min(height),
232 AvailableSpace::MinContent | AvailableSpace::MaxContent => {
233 desired_height
234 }
235 };
236 size(width, height)
237 },
238 )
239 })
240 }
241 ListSizingBehavior::Auto => window
242 .with_text_style(style.text_style().cloned(), |window| {
243 window.request_layout(style, None, cx)
244 }),
245 },
246 );
247
248 (
249 layout_id,
250 UniformListFrameState {
251 items: SmallVec::new(),
252 decorations: SmallVec::new(),
253 },
254 )
255 }
256
257 fn prepaint(
258 &mut self,
259 global_id: Option<&GlobalElementId>,
260 inspector_id: Option<&InspectorElementId>,
261 bounds: Bounds<Pixels>,
262 frame_state: &mut Self::RequestLayoutState,
263 window: &mut Window,
264 cx: &mut App,
265 ) -> Option<Hitbox> {
266 let style = self
267 .interactivity
268 .compute_style(global_id, None, window, cx);
269 let border = style.border_widths.to_pixels(window.rem_size());
270 let padding = style
271 .padding
272 .to_pixels(bounds.size.into(), window.rem_size());
273
274 let padded_bounds = Bounds::from_corners(
275 bounds.origin + point(border.left + padding.left, border.top + padding.top),
276 bounds.bottom_right()
277 - point(border.right + padding.right, border.bottom + padding.bottom),
278 );
279
280 let can_scroll_horizontally = matches!(
281 self.horizontal_sizing_behavior,
282 ListHorizontalSizingBehavior::Unconstrained
283 );
284
285 let longest_item_size = self.measure_item(None, window, cx);
286 let content_width = if can_scroll_horizontally {
287 padded_bounds.size.width.max(longest_item_size.width)
288 } else {
289 padded_bounds.size.width
290 };
291 let content_size = Size {
292 width: content_width,
293 height: longest_item_size.height * self.item_count + padding.top + padding.bottom,
294 };
295
296 let shared_scroll_offset = self.interactivity.scroll_offset.clone().unwrap();
297 let item_height = longest_item_size.height;
298 let shared_scroll_to_item = self.scroll_handle.as_mut().and_then(|handle| {
299 let mut handle = handle.0.borrow_mut();
300 handle.last_item_size = Some(ItemSize {
301 item: padded_bounds.size,
302 contents: content_size,
303 });
304 handle.deferred_scroll_to_item.take()
305 });
306
307 self.interactivity.prepaint(
308 global_id,
309 inspector_id,
310 bounds,
311 content_size,
312 window,
313 cx,
314 |style, mut scroll_offset, hitbox, window, cx| {
315 let border = style.border_widths.to_pixels(window.rem_size());
316 let padding = style
317 .padding
318 .to_pixels(bounds.size.into(), window.rem_size());
319
320 let padded_bounds = Bounds::from_corners(
321 bounds.origin + point(border.left + padding.left, border.top),
322 bounds.bottom_right() - point(border.right + padding.right, border.bottom),
323 );
324
325 let y_flipped = if let Some(scroll_handle) = &self.scroll_handle {
326 let scroll_state = scroll_handle.0.borrow();
327 scroll_state.y_flipped
328 } else {
329 false
330 };
331
332 if self.item_count > 0 {
333 let content_height =
334 item_height * self.item_count + padding.top + padding.bottom;
335 let is_scrolled_vertically = !scroll_offset.y.is_zero();
336 let min_vertical_scroll_offset = padded_bounds.size.height - content_height;
337 if is_scrolled_vertically && scroll_offset.y < min_vertical_scroll_offset {
338 shared_scroll_offset.borrow_mut().y = min_vertical_scroll_offset;
339 scroll_offset.y = min_vertical_scroll_offset;
340 }
341
342 let content_width = content_size.width + padding.left + padding.right;
343 let is_scrolled_horizontally =
344 can_scroll_horizontally && !scroll_offset.x.is_zero();
345 if is_scrolled_horizontally && content_width <= padded_bounds.size.width {
346 shared_scroll_offset.borrow_mut().x = Pixels::ZERO;
347 scroll_offset.x = Pixels::ZERO;
348 }
349
350 if let Some(deferred_scroll) = shared_scroll_to_item {
351 let mut ix = deferred_scroll.item_index;
352 if y_flipped {
353 ix = self.item_count.saturating_sub(ix + 1);
354 }
355 let list_height = padded_bounds.size.height;
356 let mut updated_scroll_offset = shared_scroll_offset.borrow_mut();
357 let item_top = item_height * ix + padding.top;
358 let item_bottom = item_top + item_height;
359 let scroll_top = -updated_scroll_offset.y;
360 let offset_pixels = item_height * deferred_scroll.offset;
361 let mut scrolled_to_top = false;
362
363 if item_top < scroll_top + padding.top + offset_pixels {
364 scrolled_to_top = true;
365 updated_scroll_offset.y = -(item_top) + padding.top + offset_pixels;
366 } else if item_bottom > scroll_top + list_height - padding.bottom {
367 scrolled_to_top = true;
368 updated_scroll_offset.y = -(item_bottom - list_height) - padding.bottom;
369 }
370
371 match deferred_scroll.strategy {
372 ScrollStrategy::Top => {}
373 ScrollStrategy::Center => {
374 if scrolled_to_top {
375 let item_center = item_top + item_height / 2.0;
376
377 let viewport_height = list_height - offset_pixels;
378 let viewport_center = offset_pixels + viewport_height / 2.0;
379 let target_scroll_top = item_center - viewport_center;
380
381 if item_top < scroll_top + offset_pixels
382 || item_bottom > scroll_top + list_height
383 {
384 updated_scroll_offset.y = -target_scroll_top
385 .max(Pixels::ZERO)
386 .min(content_height - list_height)
387 .max(Pixels::ZERO);
388 }
389 }
390 }
391 }
392 scroll_offset = *updated_scroll_offset
393 }
394
395 let first_visible_element_ix =
396 (-(scroll_offset.y + padding.top) / item_height).floor() as usize;
397 let last_visible_element_ix = ((-scroll_offset.y + padded_bounds.size.height)
398 / item_height)
399 .ceil() as usize;
400
401 let visible_range = first_visible_element_ix
402 ..cmp::min(last_visible_element_ix, self.item_count);
403
404 let items = if y_flipped {
405 let flipped_range = self.item_count.saturating_sub(visible_range.end)
406 ..self.item_count.saturating_sub(visible_range.start);
407 let mut items = (self.render_items)(flipped_range, window, cx);
408 items.reverse();
409 items
410 } else {
411 (self.render_items)(visible_range.clone(), window, cx)
412 };
413
414 let content_mask = ContentMask {
415 bounds,
416 ..Default::default()
417 };
418 window.with_content_mask(Some(content_mask), |window| {
419 for (mut item, ix) in items.into_iter().zip(visible_range.clone()) {
420 let item_origin = padded_bounds.origin
421 + point(
422 if can_scroll_horizontally {
423 scroll_offset.x + padding.left
424 } else {
425 scroll_offset.x
426 },
427 item_height * ix + scroll_offset.y + padding.top,
428 );
429 let available_width = if can_scroll_horizontally {
430 padded_bounds.size.width + scroll_offset.x.abs()
431 } else {
432 padded_bounds.size.width
433 };
434 let available_space = size(
435 AvailableSpace::Definite(available_width),
436 AvailableSpace::Definite(item_height),
437 );
438 item.layout_as_root(available_space, window, cx);
439 item.prepaint_at(item_origin, window, cx);
440 frame_state.items.push(item);
441 }
442
443 let bounds = Bounds::new(
444 padded_bounds.origin
445 + point(
446 if can_scroll_horizontally {
447 scroll_offset.x + padding.left
448 } else {
449 scroll_offset.x
450 },
451 scroll_offset.y + padding.top,
452 ),
453 padded_bounds.size,
454 );
455 for decoration in &self.decorations {
456 let mut decoration = decoration.as_ref().compute(
457 visible_range.clone(),
458 bounds,
459 scroll_offset,
460 item_height,
461 self.item_count,
462 window,
463 cx,
464 );
465 let available_space = size(
466 AvailableSpace::Definite(bounds.size.width),
467 AvailableSpace::Definite(bounds.size.height),
468 );
469 decoration.layout_as_root(available_space, window, cx);
470 decoration.prepaint_at(bounds.origin, window, cx);
471 frame_state.decorations.push(decoration);
472 }
473 });
474 }
475
476 hitbox
477 },
478 )
479 }
480
481 fn paint(
482 &mut self,
483 global_id: Option<&GlobalElementId>,
484 inspector_id: Option<&InspectorElementId>,
485 bounds: Bounds<crate::Pixels>,
486 request_layout: &mut Self::RequestLayoutState,
487 hitbox: &mut Option<Hitbox>,
488 window: &mut Window,
489 cx: &mut App,
490 ) {
491 self.interactivity.paint(
492 global_id,
493 inspector_id,
494 bounds,
495 hitbox.as_ref(),
496 window,
497 cx,
498 |_, window, cx| {
499 for item in &mut request_layout.items {
500 item.paint(window, cx);
501 }
502 for decoration in &mut request_layout.decorations {
503 decoration.paint(window, cx);
504 }
505 },
506 )
507 }
508}
509
510impl IntoElement for UniformList {
511 type Element = Self;
512
513 fn into_element(self) -> Self::Element {
514 self
515 }
516}
517
518/// A decoration for a [`UniformList`]. This can be used for various things,
519/// such as rendering indent guides, or other visual effects.
520pub trait UniformListDecoration {
521 /// Compute the decoration element, given the visible range of list items,
522 /// the bounds of the list, and the height of each item.
523 fn compute(
524 &self,
525 visible_range: Range<usize>,
526 bounds: Bounds<Pixels>,
527 scroll_offset: Point<Pixels>,
528 item_height: Pixels,
529 item_count: usize,
530 window: &mut Window,
531 cx: &mut App,
532 ) -> AnyElement;
533}
534
535impl UniformList {
536 /// Selects a specific list item for measurement.
537 pub fn with_width_from_item(mut self, item_index: Option<usize>) -> Self {
538 self.item_to_measure_index = item_index.unwrap_or(0);
539 self
540 }
541
542 /// Sets the sizing behavior, similar to the `List` element.
543 pub fn with_sizing_behavior(mut self, behavior: ListSizingBehavior) -> Self {
544 self.sizing_behavior = behavior;
545 self
546 }
547
548 /// Sets the horizontal sizing behavior, controlling the way list items laid out horizontally.
549 /// With [`ListHorizontalSizingBehavior::Unconstrained`] behavior, every item and the list itself will
550 /// have the size of the widest item and lay out pushing the `end_slot` to the right end.
551 pub fn with_horizontal_sizing_behavior(
552 mut self,
553 behavior: ListHorizontalSizingBehavior,
554 ) -> Self {
555 self.horizontal_sizing_behavior = behavior;
556 match behavior {
557 ListHorizontalSizingBehavior::FitList => {
558 self.interactivity.base_style.overflow.x = None;
559 }
560 ListHorizontalSizingBehavior::Unconstrained => {
561 self.interactivity.base_style.overflow.x = Some(Overflow::Scroll);
562 }
563 }
564 self
565 }
566
567 /// Adds a decoration element to the list.
568 pub fn with_decoration(mut self, decoration: impl UniformListDecoration + 'static) -> Self {
569 self.decorations.push(Box::new(decoration));
570 self
571 }
572
573 fn measure_item(
574 &self,
575 list_width: Option<Pixels>,
576 window: &mut Window,
577 cx: &mut App,
578 ) -> Size<Pixels> {
579 if self.item_count == 0 {
580 return Size::default();
581 }
582
583 let item_ix = cmp::min(self.item_to_measure_index, self.item_count - 1);
584 let mut items = (self.render_items)(item_ix..item_ix + 1, window, cx);
585 let Some(mut item_to_measure) = items.pop() else {
586 return Size::default();
587 };
588 let available_space = size(
589 list_width.map_or(AvailableSpace::MinContent, |width| {
590 AvailableSpace::Definite(width)
591 }),
592 AvailableSpace::MinContent,
593 );
594 item_to_measure.layout_as_root(available_space, window, cx)
595 }
596
597 /// Track and render scroll state of this list with reference to the given scroll handle.
598 pub fn track_scroll(mut self, handle: UniformListScrollHandle) -> Self {
599 self.interactivity.tracked_scroll_handle = Some(handle.0.borrow().base_handle.clone());
600 self.scroll_handle = Some(handle);
601 self
602 }
603
604 /// Sets whether the list is flipped vertically, such that item 0 appears at the bottom.
605 pub fn y_flipped(mut self, y_flipped: bool) -> Self {
606 if let Some(ref scroll_handle) = self.scroll_handle {
607 let mut scroll_state = scroll_handle.0.borrow_mut();
608 let mut base_handle = &scroll_state.base_handle;
609 let offset = base_handle.offset();
610 match scroll_state.last_item_size {
611 Some(last_size) if scroll_state.y_flipped != y_flipped => {
612 let new_y_offset =
613 -(offset.y + last_size.contents.height - last_size.item.height);
614 base_handle.set_offset(point(offset.x, new_y_offset));
615 scroll_state.y_flipped = y_flipped;
616 }
617 // Handle case where list is initially flipped.
618 None if y_flipped => {
619 base_handle.set_offset(point(offset.x, Pixels::MIN));
620 scroll_state.y_flipped = y_flipped;
621 }
622 _ => {}
623 }
624 }
625 self
626 }
627}
628
629impl InteractiveElement for UniformList {
630 fn interactivity(&mut self) -> &mut crate::Interactivity {
631 &mut self.interactivity
632 }
633}