Struct freya::prelude::VirtualScrollViewProps

pub struct VirtualScrollViewProps<Builder, BuilderArgs = ()>
where
    Builder: 'static + Clone + Fn(usize, &Option<BuilderArgs>) -> Option<VNode>,
    BuilderArgs: Clone + 'static + PartialEq,
{

    pub width: String,
    pub height: String,
    pub padding: String,
    pub scrollbar_theme: Option<ScrollBarThemeWith>,
    pub length: usize,
    pub item_size: f32,
    pub builder: Builder,
    pub builder_args: Option<BuilderArgs>,
    pub direction: String,
    pub show_scrollbar: bool,
    pub scroll_with_arrows: bool,
    pub cache_elements: bool,
    pub scroll_controller: Option<ScrollController>,
    pub invert_scroll_wheel: bool,
}

Properties for the VirtualScrollView component.

Fields

width: String

Width of the VirtualScrollView container. Default to fill.

height: String

Height of the VirtualScrollView container. Default to fill.

padding: String

Padding of the VirtualScrollView container.

scrollbar_theme: Option<ScrollBarThemeWith>

Theme override for the scrollbars.

length: usize

Quantity of items in the VirtualScrollView.

item_size: f32

Size of the items, height for vertical direction and width for horizontal.

builder: Builder

The item builder function.

builder_args: Option<BuilderArgs>

The values for the item builder function.

direction: String

Direction of the VirtualScrollView, vertical or horizontal.

show_scrollbar: bool

Show the scrollbar, visible by default.

scroll_with_arrows: bool

Enable scrolling with arrow keys.

cache_elements: bool

Cache elements or not, changing builder_args will invalidate the cache if enabled. Default is true.

scroll_controller: Option<ScrollController>

Custom Scroll Controller for the Virtual ScrollView.

invert_scroll_wheel: bool

If false (default), wheel scroll with no shift will scroll vertically no matter the direction. If true, wheel scroll with no shift will scroll horizontally.

Implementations

impl<Builder, BuilderArgs> VirtualScrollViewProps<Builder, BuilderArgs>

where Builder: 'static + Clone + Fn(usize, &Option<BuilderArgs>) -> Option<VNode>, BuilderArgs: Clone + 'static + PartialEq,

pub fn builder() -> VirtualScrollViewPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ()), Builder, BuilderArgs>

Create a builder for building VirtualScrollViewProps. On the builder, call .width(...)(optional), .height(...)(optional), .padding(...)(optional), .scrollbar_theme(...)(optional), .length(...), .item_size(...), .builder(...), .builder_args(...)(optional), .direction(...)(optional), .show_scrollbar(...)(optional), .scroll_with_arrows(...)(optional), .cache_elements(...)(optional), .scroll_controller(...)(optional), .invert_scroll_wheel(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of VirtualScrollViewProps.

Trait Implementations

impl<Builder, BuilderArgs> Clone for VirtualScrollViewProps<Builder, BuilderArgs>

where Builder: Clone + 'static + Fn(usize, &Option<BuilderArgs>) -> Option<VNode>, BuilderArgs: Clone + 'static + PartialEq,

fn clone(&self) -> VirtualScrollViewProps<Builder, BuilderArgs>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BuilderArgs, Builder> PartialEq for VirtualScrollViewProps<Builder, BuilderArgs>

where BuilderArgs: Clone + PartialEq, Builder: Clone + Fn(usize, &Option<BuilderArgs>) -> Option<VNode>,

fn eq(&self, other: &VirtualScrollViewProps<Builder, BuilderArgs>) -> 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.

impl<Builder, BuilderArgs> Properties for VirtualScrollViewProps<Builder, BuilderArgs>

where Builder: 'static + Clone + Fn(usize, &Option<BuilderArgs>) -> Option<VNode>, BuilderArgs: Clone + 'static + PartialEq, VirtualScrollViewProps<Builder, BuilderArgs>: Clone,

type Builder = VirtualScrollViewPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ()), Builder, BuilderArgs>

The type of the builder for this component. Used to create “in-progress” versions of the props.

fn builder() -> <VirtualScrollViewProps<Builder, BuilderArgs> as Properties>::Builder

Create a builder for this component.

fn memoize( &mut self, new: &VirtualScrollViewProps<Builder, BuilderArgs>, ) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, component_name: &'static str, ) -> VComponent

where M: 'static,

Create a component from the props.