rippleShow
Commons
stable
Trigger the ripple animation on an element in response to a pointer or keyboard event. Handles touch vs. mouse distinctions and respects the stop-propagation flag.
API
Signature
Full TypeScript signature sourced from the util file.
API
Parameters
Input parameters accepted by this util.
- erequiredTRippleEvent
- The triggering event (MouseEvent, TouchEvent, or KeyboardEvent). The element is read from e.currentTarget.
API
Return value
The value returned by this util.
- No return value. The ripple animation is applied as a side-effect on the element.
Usage
Examples
Ready-to-paste usage snippets.
Attach to a mousedown listener