Struct ScrollableAxes 

pub struct ScrollableAxes {
    pub x: Signal<f32>,
    pub y: Signal<f32>,
    pub max_x: Signal<f32>,
    pub max_y: Signal<f32>,
    pub overscroll: Signal<Vec2>,
}

The reactive state one scrollable surface scrolls: where it is on each axis, how far it can go, and how far past the end it is currently being held.

Every field is a Signal, and they are the shared ones — the same handles a ScrollBar reads and an ensure_visible writes — so this type is a view onto the widget’s state rather than a second copy of it. Cloning is cloning handles.

An offset must be Signal::new_animated on a surface that turns ScrollHandlingOptions::smooth on and gives that axis a range: animate_to on a plain signal panics. An axis with a permanently zero range is never written by either path, so a surface that scrolls on one axis only may leave the other plain.

Fields

x: Signal<f32>

Horizontal offset, 0.0 at the leading edge.

y: Signal<f32>

Vertical offset, 0.0 at the top.

max_x: Signal<f32>

Largest legal x — content width minus viewport width, never below zero.

max_y: Signal<f32>

Largest legal y.

overscroll: Signal<Vec2>

How far past the range the content is being held right now, per axis, after the rubber band. Always ZERO under OverscrollStyle::Clamp, under reduced motion, and outside a live pan.

Published for a surface that wants to draw the stretch or the glow; the offset itself never leaves the range, so a surface that ignores this signal is still correct.

Implementations

impl ScrollableAxes

pub fn new( x: Signal<f32>, y: Signal<f32>, max_x: Signal<f32>, max_y: Signal<f32>, ) -> Self

Both axes, with a fresh overscroll signal.

pub fn vertical(y: Signal<f32>, max_y: Signal<f32>) -> Self

A vertical-only surface: the horizontal axis is pinned at zero with a zero range, so nothing can ever move it.

The pinned axis is a plain signal. Both paths write an axis only when its clamp actually moved, and an axis whose range is zero and whose offset is already zero never moves — so the tween that would panic on a plain signal is unreachable here.

pub fn horizontal(x: Signal<f32>, max_x: Signal<f32>) -> Self

A horizontal-only surface. The pinned axis is plain, for the reason given on vertical.

Trait Implementations

impl Clone for ScrollableAxes

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 ScrollableAxes

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

Formats the value using the given formatter.