rippleCancelShow
Commons
stable
Cancel a pending ripple show on a touch/mouse move event. Clears the show-timer commit and the pending timeout so a ripple that has not yet appeared is silently discarded.
API
Signature
Full TypeScript signature sourced from the util file.
API
Parameters
Input parameters accepted by this util.
- erequiredMouseEvent | TouchEvent
- The pointer move event whose currentTarget holds the ripple state object. If the element has no _ripple state or no pending show, the call is a no-op.
API
Return value
The value returned by this util.
- No return value. Side-effects: clears showTimerCommit and showTimer on the element ripple state.
Usage
Examples
Ready-to-paste usage snippets.
Wire cancel-show to touchmove