IRippleOptions

interface
Behaviour

Options passed to the v-ripple directive when an object value is used. Controls the visual behaviour of the ripple wave: extra class, centred start, and forced circular shape.

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.

class
string
Extra CSS class appended to every ripple wave element for custom styling.
center
boolean
When true, the ripple always starts from the centre of the host element.
circle
boolean
When true, constrains the ripple to a perfect circle regardless of the element dimensions.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Using v-ripple with options

html