IRippleHtmlElementRipple

interface
Behaviour

Internal state bag stored on a DOM element's _ripple property by the v-ripple directive. Tracks whether the ripple is enabled, centered, circular, and manages the show-timer commit callback.

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.

enabled
boolean
Whether the ripple effect is active on this element.
centered
boolean
When true, the ripple always starts from the centre of the element rather than from the pointer position.
circle
boolean
When true, the ripple is forced to a perfect circle (useful for icon buttons).
class
string
Extra CSS class added to each ripple wave element.
touched
boolean
Marks that the last interaction was a touch event.
isTouch
boolean
Whether the current device has active touch support.
showTimer
number
Timer ID used to delay the ripple show on touch to distinguish taps from scrolls.
showTimerCommit
null | (() => void)
Callback queued by showTimer — invoked to actually paint the ripple, or cleared on cancel.
timers
Set<ReturnType<typeof setTimeout>>

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Accessing the internal ripple state on an element

typescript