IRippleDirectiveBinding

interface
Directives

Typed directive binding for `v-ripple` — extends Vue's DirectiveBinding with a narrowed `value` (boolean or `{ class }` object) and typed `modifiers` for center, circle and stop behaviours.

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.

value
boolean | { class: string }
Binding value. `true` enables the ripple with defaults; `false` disables it; an object with a `class` string appends that class to every ripple element.
modifiers
required
{ center?: boolean circle?: boolean stop?: boolean }
Directive modifiers: `center` anchors the wave origin to the element centre; `circle` forces a perfectly circular wave; `stop` prevents event propagation when the ripple triggers.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Accessing the typed binding in a directive hook

typescript