SCROLL_BEHAVIOR

enum
Behavior

TypeScript enum for Toolbar scroll behavior — hide, invert, collapse, elevate, or activate on scroll.

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_BEHAVIOR.HIDE
Toolbar slides out of view when the user scrolls down and reappears on scroll up.
SCROLL_BEHAVIOR.INVERTED
Inverted hide — toolbar shows when scrolling down and hides when scrolling up.
SCROLL_BEHAVIOR.COLLAPSE
Toolbar shrinks (collapses) its height as the user scrolls down.
SCROLL_BEHAVIOR.ELEVATED
Toolbar gains an elevation shadow when the page is scrolled away from the top.
SCROLL_BEHAVIOR.ACTIVE
Toolbar enters an active/highlighted state when the page is scrolled.

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