IRippleElement

interface
Directives

Individual ripple DOM element — extends Element with an optional `dataset` typed as `IRippleElementDataset`, giving typed access to the `isHiding` and `activated` data attributes written by the ripple animation engine.

TypeScript

Definition

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

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

dataset
IRippleElementDataset
Typed dataset providing access to `isHiding` and `activated` flags written by the ripple animation lifecycle.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Checking ripple animation state

typescript