Struct ScrollRoom 

pub struct ScrollRoom {
    pub offset: Pixels,
    pub max_offset: Pixels,
}

Whether a vertically scrollable region can still absorb wheel motion in the direction the user is scrolling.

This is the containment test behind native scroll chaining: an inner component traps the wheel while it has room, and releases it to the surrounding page once it bottoms out or tops up. offset and max_offset use the GPUI convention where the offset is zero at the top of the content and -max_offset at the bottom.

Fields

offset: Pixels

Current vertical scroll offset (zero or negative).

max_offset: Pixels

Maximum magnitude of the offset (zero means nothing to scroll).

Implementations

impl ScrollRoom

pub fn new(offset: Pixels, max_offset: Pixels) -> Self

Builds a room snapshot from a GPUI scroll handle’s reported state.

pub fn can_absorb(&self, delta_y: Pixels) -> bool

True when scrolling by delta_y (negative = down) would move this region: it has scrollable content and is not already pinned against the edge in that direction.

pub fn from_handle(handle: &ScrollHandle) -> Self

Snapshots the room from a GPUI ScrollHandle.

This is the form used by components whose scrolling lives in a div().overflow_y_scroll().track_scroll(&handle) container.

pub fn from_list_state(state: &ListState) -> Self

Snapshots the room from a GPUI [gpui::ListState].

Trait Implementations

impl Clone for ScrollRoom

fn clone(&self) -> ScrollRoom

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScrollRoom

impl Debug for ScrollRoom

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

Formats the value using the given formatter.