Struct ScrollState 

pub struct ScrollState { /* private fields */ }

The scroll position of a ScrollColumn or ScrollRow, and a handle to move it.

The Renderer owns the scroll physics and the scrollbar; this handle reads the current offset and maximum offset in dp as observable states and sends target scroll requests.

Implementations

impl ScrollState

pub fn new() -> Self

Creates a new scroll state starting at 0 dp.

pub fn offset(&self) -> f32

The current scroll offset in dp. A composable that reads this runs again when the user or a programmatic scroll moves the container.

pub fn max_offset(&self) -> f32

The furthest offset in dp the container can scroll to (0.0 when the content fits inside the viewport). A composable that reads this runs again when the content or viewport size changes the scrollable distance.

pub fn scroll_to(&self, dp: f32)

Jumps to dp (clamped by the Renderer to 0.0..=max_offset).

pub fn animate_scroll_to(&self, dp: f32)

Smoothly scrolls to dp (clamped by the Renderer to 0.0..=max_offset).

Trait Implementations

impl Clone for ScrollState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollState

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

Formats the value using the given formatter.

impl Default for ScrollState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScrollState

impl PartialEq for ScrollState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScrollState