fn
onKeyDown
v0.0.14testeddemoListen for keydown strokes. Shorthand for onKeyStroke with eventName: 'keydown'.
Example
ts
onKeyDown('Enter', submit);Demo
Loading demo…
Signature
ts
export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<OnKeyStrokeOptions, 'eventName'> ={ ... }Parameters
| Parameter | Type | Description |
|---|---|---|
key | KeyFilter | Key, list of keys, or predicate to match |
handler | (event: KeyboardEvent) => void | Callback invoked on a matching key event |
options? | Omit<OnKeyStrokeOptions, 'eventName'> | Listener configuration |
Returns
VoidFunctionStop handle that removes the listener