pub struct ListView { /* private fields */ }Expand description
A scrolling list that builds only the rows in view, so a list of
thousands costs what a screenful does. Offsets are f32, which stays
exact to about 16 million pixels: some 700,000 rows of 24 pixels. It
follows a list of items as children_keyed
does: each row is kept while its item’s key stays in the list.
Rows may differ in height. Each is at least
row_height tall and grows to fit its content,
and its height, measured once it is laid out, is kept by its key. A row
not built yet counts as row_height, so set it near the usual row’s
height. A row that starts above the view grows upward, so the rows
shown stay where they are.
use crabshell_ui::{ListView, Text};
let apps = ListView::new(
|| (1..=500).map(|n| format!("app {n}")).collect::<Vec<_>>(),
|name| name.clone(),
|_cx, name| Text::new(move || name.get()),
)
.row_height(28)
.height(280);Implementations§
Source§impl ListView
impl ListView
Sourcepub const DEFAULT_ROW_HEIGHT: u32 = 24
pub const DEFAULT_ROW_HEIGHT: u32 = 24
The default row height, in logical pixels.
Sourcepub const DEFAULT_HEIGHT: u32 = 240
pub const DEFAULT_HEIGHT: u32 = 240
The default height of the list, in logical pixels.
Sourcepub fn new<T, K, W>(
items: impl FnMut() -> Vec<T> + 'static,
key: impl FnMut(&T) -> K + 'static,
view: impl FnMut(&Cx, Memo<T>) -> W + 'static,
) -> ListView
pub fn new<T, K, W>( items: impl FnMut() -> Vec<T> + 'static, key: impl FnMut(&T) -> K + 'static, view: impl FnMut(&Cx, Memo<T>) -> W + 'static, ) -> ListView
A list with a row for each of items, built by view and kept by
key, as in children_keyed.
Sourcepub fn horizontal(self, horizontal: impl IntoProp<bool>) -> ListView
pub fn horizontal(self, horizontal: impl IntoProp<bool>) -> ListView
Runs the rows left to right in a horizontal scroll view instead.
row_height and height then
mean each row’s width and the list’s, and each row is as tall as the
list. Turning it measures every row again.
Sourcepub fn row_height(self, height: impl IntoProp<u32>) -> ListView
pub fn row_height(self, height: impl IntoProp<u32>) -> ListView
Sets the height in logical pixels that each row has at least, and that a row not yet built counts as. 24 by default.
Sourcepub fn height(self, height: impl IntoProp<u32>) -> ListView
pub fn height(self, height: impl IntoProp<u32>) -> ListView
Sets the list’s height in logical pixels.
Sourcepub fn current(self, index: impl IntoProp<Option<usize>>) -> ListView
pub fn current(self, index: impl IntoProp<Option<usize>>) -> ListView
Keeps the row at this index in view, scrolling as little as needed
whenever it changes. A row not built yet is found by row_height,
then shown whole once it is measured. An index past the end is
scrolled to once the items reach it; None scrolls nothing. While
the list moves, in a fling, a drag, a touchpad gesture or a
spring-back, a change scrolls nothing, though a highlight still
follows it, and the motion’s end doesn’t scroll back to it.
Sourcepub fn highlight(self, style: impl IntoProp<Option<Style>>) -> ListView
pub fn highlight(self, style: impl IntoProp<Option<Style>>) -> ListView
Draws a box in this style behind the current
row, as long as the row and across the list. When the current row
changes, the box moves to it over the style’s transition rather
than jumping, and takes its length at once. It is drawn moved, so a
move repaints but doesn’t lay the window out. No current row, or
None, the default, draws none.
Sourcepub fn offset(self, offset: Signal<f32>) -> ListView
pub fn offset(self, offset: Signal<f32>) -> ListView
Shares the offset, as ScrollView::offset does.
Sourcepub fn kinetic(self, kinetic: impl IntoProp<bool>) -> ListView
pub fn kinetic(self, kinetic: impl IntoProp<bool>) -> ListView
Keeps the list moving after a fling, as ScrollView::kinetic
does. On by default.
Sourcepub fn overshoot(self, overshoot: impl IntoProp<bool>) -> ListView
pub fn overshoot(self, overshoot: impl IntoProp<bool>) -> ListView
Lets the list go past its ends, as ScrollView::overshoot does.
On by default.
Sourcepub fn scroll_bar(self, style: impl IntoProp<Option<Style>>) -> ListView
pub fn scroll_bar(self, style: impl IntoProp<Option<Style>>) -> ListView
Draws a scroll bar, as ScrollView::scroll_bar does.
Sourcepub fn visible(self, visible: impl IntoProp<bool>) -> Self
pub fn visible(self, visible: impl IntoProp<bool>) -> Self
Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.
Sourcepub fn geometry(self, geometry: Signal<Rect>) -> Self
pub fn geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is: after each layout that moves or
resizes it, its laid-out rectangle in the window’s logical
pixels, scrolled with any scroll view around it but not moved by
a style’s translate, scale or rotate, is written to geometry. A
hidden widget writes nothing. An effect that reads it may change
the layout: the window is laid out again at once, until nothing
moves.