IScrollStrategyProps

interface
Scroll

Overlay scroll-strategy props. Extended by Overlay, Tooltip and related components to let consumers choose how the floating panel reacts when the page or its ancestor container scrolls.

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.

scrollStrategy
TScrollStrategy | TScrollStrategyFn
Named strategy (block, close, none, reposition) or a custom TScrollStrategyFn callback that receives IScrollStrategyData.
contained
boolean
When true, the overlay is positioned inside its scroll container rather than the document root, so the positioning engine observes the container scroll instead.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Configuring scroll strategy on a Tooltip

html