fn

onKeyUp

v0.0.14testeddemo

Listen for keyup strokes. Shorthand for onKeyStroke with eventName: 'keyup'.

Example

ts
onKeyUp('Escape', close);

Demo

Loading demo…

Signature

ts
export function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<OnKeyStrokeOptions, 'eventName'> ={ ... }

Parameters

ParameterTypeDescription
keyKeyFilterKey, list of keys, or predicate to match
handler(event: KeyboardEvent) => voidCallback invoked on a matching key event
options?Omit<OnKeyStrokeOptions, 'eventName'>Listener configuration

Returns

VoidFunctionStop handle that removes the listener