IRippleHtmlElement

interface
Directives

Augmented HTMLElement that carries the `_ripple` private state bag written by `v-ripple`. All fields are optional so the interface can be safely cast from any HTMLElement and read without null-guard noise.

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.

_ripple
IRippleHtmlElementRipple
Private state bag attached to the host element by the v-ripple directive. Holds configuration (enabled, centered, circle, class) and animation bookkeeping (touched, isTouch, showTimer, showTimerCommit).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Checking ripple state on an element

typescript