ilokesto

useKey

useKey invokes a handler when a key matching a KeyboardEvent.code value (or "*" for any key) is pressed.

import { useKey } from '@ilokesto/utilinent/hooks';

function Modal() {
  useKey('Escape', () => close());
  useKey('KeyS', save, { ignoreEditable: true });
  return <dialog>{children}</dialog>;
}

Options

OptionDescription
enabledWhen false, the handler is not invoked. Defaults to true.
eventkeydown (default) or keyup.
ignoreEditableIgnore events from input/textarea/select/contenteditable.

On this page