Skip to main content

ListView

Struct ListView 

Source
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

Source

pub const DEFAULT_ROW_HEIGHT: u32 = 24

The default row height, in logical pixels.

Source

pub const DEFAULT_HEIGHT: u32 = 240

The default height of the list, in logical pixels.

Source

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
where T: Clone + PartialEq + 'static, K: Eq + Hash + 'static, W: Widget,

A list with a row for each of items, built by view and kept by key, as in children_keyed.

Source

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.

Source

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.

Source

pub fn height(self, height: impl IntoProp<u32>) -> ListView

Sets the list’s height in logical pixels.

Source

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.

Source

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.

Source

pub fn offset(self, offset: Signal<f32>) -> ListView

Shares the offset, as ScrollView::offset does.

Source

pub fn kinetic(self, kinetic: impl IntoProp<bool>) -> ListView

Keeps the list moving after a fling, as ScrollView::kinetic does. On by default.

Source

pub fn overshoot(self, overshoot: impl IntoProp<bool>) -> ListView

Lets the list go past its ends, as ScrollView::overshoot does. On by default.

Source

pub fn scroll_bar(self, style: impl IntoProp<Option<Style>>) -> ListView

Draws a scroll bar, as ScrollView::scroll_bar does.

Source

pub fn style(self, style: impl IntoProp<Style>) -> ListView

Sets the list’s style.

Source

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.

Source

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.

Trait Implementations§

Source§

impl Widget for ListView

Source§

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more