IRippleProps

interface
Behaviour

Component prop surface for the ripple effect. Extended by interactive components (Btn, Chip, Card, ListItem…) to opt in to the v-ripple ink-wave animation on pointer interaction.

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.

ripple
boolean | { class: string }
Enable the ripple ink-wave. Pass true/false to toggle, or an object with a class key to attach a custom CSS class to the wave element.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Extending IRippleProps on a custom component

typescript