Struct VirtualScrollView 

pub struct VirtualScrollView<D, B: Fn(VirtualItem, &D) -> Element> { /* private fields */ }

One-direction scrollable area that dynamically builds and renders items based in their size and current available size, this is intended for apps using large sets of data that need good performance.

Example

fn app() -> impl IntoElement {
    rect().child(
        VirtualScrollView::new(|item, _| {
            rect()
                .key(item.index)
                .height(Size::px(item.size))
                .padding(4.)
                .child(format!("Item {}", item.index))
                .into()
        })
        .length(300usize)
        .item_size(25.),
    )
}

Preview

Implementations

impl<B: Fn(VirtualItem, &()) -> Element> VirtualScrollView<(), B>

pub fn new(builder: B) -> Self

Creates a VirtualScrollView that builds each item from its VirtualItem.

pub fn new_controlled(builder: B, scroll_controller: ScrollController) -> Self

Same as Self::new but driven by an external ScrollController.

impl<D, B: Fn(VirtualItem, &D) -> Element> VirtualScrollView<D, B>

pub fn new_with_data(builder_data: D, builder: B) -> Self

Same as Self::new but passes builder_data to the builder for every item.

builder_data is owned by the scroll view and handed to the builder by reference instead of being captured in the closure. It is part of the view’s equality check, so changing it rebuilds the visible items.

pub fn new_with_data_controlled( builder_data: D, builder: B, scroll_controller: ScrollController, ) -> Self

Same as Self::new_with_data but driven by an external ScrollController.

pub fn show_scrollbar(self, show_scrollbar: bool) -> Self

pub fn direction(self, direction: Direction) -> Self

pub fn scroll_with_arrows(self, scroll_with_arrows: impl Into<bool>) -> Self

pub fn item_size(self, item_size: impl Into<ItemSize>) -> Self

pub fn length(self, length: impl Into<usize>) -> Self

pub fn invert_scroll_wheel(self, invert_scroll_wheel: impl Into<bool>) -> Self

pub fn drag_scrolling(self, drag_scrolling: bool) -> Self

pub fn scroll_controller( self, scroll_controller: impl Into<Option<ScrollController>>, ) -> Self

pub fn max_width(self, max_width: impl Into<Size>) -> Self

pub fn max_height(self, max_height: impl Into<Size>) -> Self

Trait Implementations

impl<D: Clone, B: Clone + Fn(VirtualItem, &D) -> Element> Clone for VirtualScrollView<D, B>

fn clone(&self) -> VirtualScrollView<D, B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: PartialEq + 'static, B: Fn(VirtualItem, &D) -> Element + 'static> Component for VirtualScrollView<D, B>

fn render(self: &VirtualScrollView<D, B>) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl<D: PartialEq, B: Fn(VirtualItem, &D) -> Element> ContainerSizeExt for VirtualScrollView<D, B>

fn width(self, width: impl Into<Size>) -> Self

Set the element’s width. See [Size].

fn height(self, height: impl Into<Size>) -> Self

Set the element’s height. See [Size].

fn expanded(self) -> Self

Expand both width and height using [Size::fill()].

impl<D: PartialEq, B: Fn(VirtualItem, &D) -> Element> KeyExt for VirtualScrollView<D, B>

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl<D: PartialEq, B: Fn(VirtualItem, &D) -> Element> LayoutExt for VirtualScrollView<D, B>

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See [LayoutData].

impl<D: PartialEq, B: Fn(VirtualItem, &D) -> Element> PartialEq for VirtualScrollView<D, B>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.