Skip to main content

VirtualScrollState

Struct VirtualScrollState 

Source
pub struct VirtualScrollState { /* private fields */ }
Expand description

State for virtual scrolling of a list.

Implementations§

Source§

impl VirtualScrollState

Source

pub fn new(total_items: usize, item_height: ItemHeight) -> Self

Creates a new virtual scroll state.

Source

pub fn with_config( total_items: usize, item_height: ItemHeight, config: VirtualScrollConfig, ) -> Self

Creates a new virtual scroll state with configuration.

Source

pub fn set_container(&mut self, node: NodeId)

Sets the container node for the scroll content.

Source

pub fn container(&self) -> Option<NodeId>

Gets the container node.

Source

pub fn set_total_items(&mut self, count: usize)

Updates the total number of items.

Source

pub fn total_items(&self) -> usize

Gets the total number of items.

Source

pub fn set_viewport_height(&mut self, height: f32)

Updates the viewport height.

Source

pub fn viewport_height(&self) -> f32

Gets the viewport height.

Source

pub fn total_height(&self) -> f32

Calculates the total scroll height.

Source

pub fn max_scroll_offset(&self) -> f32

Gets the maximum scroll offset.

Source

pub fn scroll_offset(&self) -> f32

Gets the current scroll offset.

Source

pub fn set_scroll_offset(&mut self, offset: f32)

Sets the scroll offset directly.

Source

pub fn scroll_by(&mut self, delta: f32)

Scrolls by a delta amount.

Source

pub fn scroll_to_item(&mut self, index: usize)

Scrolls to show a specific item.

Source

pub fn scroll_to_item_centered(&mut self, index: usize)

Scrolls to center a specific item in the viewport.

Source

pub fn get_item_offset(&self, index: usize) -> f32

Gets the Y offset for an item at the given index.

Source

pub fn get_item_at_position(&self, y: f32) -> Option<usize>

Gets the item index at a given Y position.

Source

pub fn update_animation(&mut self, dt: f32) -> bool

Updates smooth scrolling animation. Returns true if the scroll position changed.

Source

pub fn calculate_visible_range(&self) -> Range<usize>

Calculates the visible range based on current scroll position.

Source

pub fn update_visible(&mut self) -> (Vec<usize>, Vec<usize>)

Updates the visible range and returns items that need to be mounted/unmounted. Returns (items_to_mount, items_to_unmount).

Source

pub fn mount_item(&mut self, index: usize, node_id: NodeId, height: f32)

Records a mounted item.

Source

pub fn unmount_item(&mut self, index: usize) -> Option<NodeId>

Unmounts an item and returns its node ID.

Source

pub fn get_mounted(&self, index: usize) -> Option<&MountedItem>

Gets the mounted item for an index.

Source

pub fn mounted_items(&self) -> impl Iterator<Item = (usize, &MountedItem)>

Gets all mounted items.

Source

pub fn visible_range(&self) -> Range<usize>

Gets the current visible range.

Source

pub fn is_visible(&self, index: usize) -> bool

Checks if an index is in the visible range.

Source

pub fn stats(&self) -> &VirtualScrollStats

Gets statistics about the virtual scroll.

Source

pub fn update_stats(&mut self)

Updates statistics.

Source

pub fn config(&self) -> &VirtualScrollConfig

Gets the configuration.

Source

pub fn config_mut(&mut self) -> &mut VirtualScrollConfig

Gets mutable configuration.

Trait Implementations§

Source§

impl Debug for VirtualScrollState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,