Struct ScrollState 

pub struct ScrollState { /* private fields */ }

State object for scroll position tracking.

Holds the current scroll offset and provides methods to programmatically control scrolling. Can be created with rememberScrollState().

This is a pure scroll model - it does NOT store ephemeral gesture/pointer state. Gesture state is managed locally in the scroll modifier.

Implementations

impl ScrollState

pub fn new(initial: f32) -> ScrollState

Creates a new ScrollState with the given initial scroll position.

pub fn set_settle_policy(&self, policy: Option<Rc<dyn Fn(f32, f32) -> f32>>)

Installs (or clears) the settle policy consulted when interactions end.

pub fn settle_policy(&self) -> Option<Rc<dyn Fn(f32, f32) -> f32>>

The currently installed settle policy, if any.

pub fn id(&self) -> u64

Get the unique ID of this ScrollState

pub fn value(&self) -> f32

Gets the current scroll position in pixels (reactive - triggers recomposition).

Use this in Composable functions when you want UI to update on scroll. Example: Text("Scroll position: ${scrollState.value()}")

pub fn value_non_reactive(&self) -> f32

Gets the current scroll position in pixels (non-reactive).

Use this in layout/measure phase to avoid triggering recomposition. This is called internally by ScrollNode::measure().

pub fn max_value(&self) -> f32

Gets the maximum scroll value.

pub fn dispatch_raw_delta(&self, delta: f32) -> f32

Scrolls by the given delta, clamping to valid range [0, max_value]. Returns the actual amount scrolled.

pub fn viewport_extent(&self) -> f32

The main-axis extent of the scroll viewport, as the last measure pass resolved it.

pub fn content_extent(&self) -> f32

The whole scrollable content along the main axis.

pub fn metrics(&self) -> ScrollMetrics

Everything an indicator needs about this scroll, read together so it cannot mix a position from one frame with an extent from another.

Read outside composition — during draw, or from a gesture — so following a scroll costs no recomposition.

pub fn scroll_to(&self, position: f32)

Scrolls to the given position immediately.

Trait Implementations

impl Clone for ScrollState

fn clone(&self) -> ScrollState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScrollState

impl PartialEq for ScrollState

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

Equality operator ==.

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

Inequality operator !=.