SCROLL_STRATEGIES

enum
Behavior

TypeScript enum for overlay scroll strategy — none, close, block, or reposition.

TypeScript

Definition

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

typescript

Members

Members

All members of this enum. Click a value to copy it to clipboard.

SCROLL_STRATEGIES.NONE
No scroll strategy — overlay stays visible and scroll is unrestricted.
SCROLL_STRATEGIES.CLOSE
Overlay closes automatically when the user scrolls.
SCROLL_STRATEGIES.BLOCK
Body scroll is blocked while the overlay is open.
SCROLL_STRATEGIES.REPOSITION
Overlay repositions itself as the user scrolls to stay anchored to its target element.

Ecosystem

Used by

Components and props that accept this enum as a value.

Usage

Examples

Ready-to-paste code snippets using this enum.

Using the enum in script setup

typescript