IRippleElementDataset

interface
Directives

Typed `dataset` shape on a ripple wave element — two string flags written by the animation engine to track whether the wave is currently fading out and whether it has been activated.

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.

isHiding
string
Set to "true" when the ripple wave is in its fade-out phase. Used to coordinate removal from the DOM after the animation completes.
activated
string
ISO timestamp string written when the wave is first activated. Used to compute animation timing relative to the pointer event.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reading dataset flags from a ripple wave element

typescript