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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- enabledboolean
- Whether the ripple effect is active on this element.
- centeredboolean
- When true, the ripple always starts from the centre of the element rather than from the pointer position.
- circleboolean
- When true, the ripple is forced to a perfect circle (useful for icon buttons).
- classstring
- Extra CSS class added to each ripple wave element.
- touchedboolean
- Marks that the last interaction was a touch event.
- isTouchboolean
- Whether the current device has active touch support.
- showTimernumber
- Timer ID used to delay the ripple show on touch to distinguish taps from scrolls.
- showTimerCommitnull | (() => void)
- Callback queued by showTimer — invoked to actually paint the ripple, or cleared on cancel.
- timersSet<ReturnType<typeof setTimeout>>
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Accessing the internal ripple state on an element