IScrollArguments

interface
Scroll

Arguments bag passed into scroll-behaviour handler functions. Provides a reactive ref indicating whether the target element can currently scroll, allowing behaviours to guard against no-op updates.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

canScroll
Readonly<Ref<boolean>>
Reactive flag set to true when the scroll target has scrollable overflow. Behaviours should read this before mutating layout.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Using IScrollArguments in a custom scroll behaviour

typescript