rippleHide
Commons
stable
Trigger the hide animation for an active ripple on a mouse/touch end or leave event. Handles the special case where a touchend arrives before the show-timer fires, committing and then queuing the hide.
API
Signature
Full TypeScript signature sourced from the util file.
API
Parameters
Input parameters accepted by this util.
- erequiredEvent
- The DOM event whose currentTarget holds the element with ripple state (_ripple). Supported types: mouseup, mouseleave, touchend, touchcancel, keyup, blur, dragstart.
API
Return value
The value returned by this util.
- No return value. Triggers the RIPPLES.hide() animation on the element and clears the show timer.
Usage
Examples
Ready-to-paste usage snippets.
Wire hide to pointer release events