RIPPLE_OPTIONS

const
Interaction & Animation

Default configuration object for the v-ripple directive — defines the CSS class, centering mode, shape, animation duration, easing function, opacity, and initial position of each ripple element.

TypeScript

Definition

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

typescript

Entries

Values

All entries in this constant. Click a value to copy it to clipboard.

class: 'origam-ripple__element'
CSS class applied to the ripple element.
center: false
When true the ripple originates from the element centre, not the click point.
circle: false
When true the ripple is forced to a circular shape.
duration: 1000
Total ripple animation duration in milliseconds.
easing: 'ease-out'
CSS easing function applied to the ripple expand animation.
opacity: 0.3
Peak opacity of the ripple wave at the centre of the animation.
x: 0
Initial horizontal offset of the ripple origin in pixels.
y: 0
Initial vertical offset of the ripple origin in pixels.

Ecosystem

Used by

Composables and components that consume this constant.

Usage

Examples

Ready-to-paste code snippets using this constant.

Merging custom options with defaults

typescript