keyboardRippleShow

Commons
stable

Triggers the ripple effect on Enter or Space keydown, setting the internal keyboard-ripple flag. No-ops for any other key.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

e
required
KeyboardEvent
The keydown KeyboardEvent. Only Enter and Space activate the ripple.

API

Return value

The value returned by this util.

No return value. Activates the ripple effect when the key matches Enter or Space.

Usage

Examples

Ready-to-paste usage snippets.

Attach keyboard ripple to a button

typescript