Struct ScrollableController 

pub struct ScrollableController { /* private fields */ }

Holds the state for a scrollable component, managing scroll position and interaction.

It tracks the current and target scroll positions, the size of the scrollable content, and focus state.

The scroll position is smoothly interpolated over time to create a fluid scrolling effect.

Implementations

impl ScrollableController

pub fn new() -> Self

Creates a new ScrollableController with default values.

pub fn child_position(&self) -> PxPosition

Returns the current child position relative to the scrollable container.

This is primarily useful for components that need to implement custom virtualization strategies (e.g. lazy lists) and must know the current scroll offset. Values are clamped by the scroll logic, so consumers can safely derive their offset from the returned position.

pub fn is_positioned(&self) -> bool

Returns whether this viewport has been positioned by scrolling yet.

A freshly created controller reports false. Any scroll input, programmatic position or animation marks it as positioned, so consumers can distinguish an untouched viewport from one that currently sits at the top.

pub fn visible_size(&self) -> ComputedData

Returns the currently visible viewport size of the scrollable container.

pub fn override_child_size(&mut self, size: ComputedData)

Overrides the child size used for scroll extent calculation.

The new extent is immediately available to scrolling and scrollbars.

pub fn set_scroll_position(&mut self, position: PxPosition)

Instantly sets the scroll position without animation.

This is useful for restoring a saved scroll position when remounting a component.

Trait Implementations

impl Clone for ScrollableController

fn clone(&self) -> ScrollableController

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ScrollableController

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ScrollableController

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScrollableController