UNPKG

@acusti/use-keyboard-events

Version:

React hook that takes keyboard event handlers and attaches them to the document

15 lines (14 loc) 609 B
import { Handler } from './handlers.js'; export { isEventTargetUsingKeyEvent, isPrimaryModifierPressed, usesKeyEvents, } from './handlers.js'; type Props = { ignoreUsedKeyboardEvents?: boolean; onKeyDown?: Handler; onKeyPress?: Handler; onKeyUp?: Handler; /** * Priority defines what order handlers should be invoked and defaults to 0. * It can be any number between -50 (lowest priority) and 50 (highest priority). */ priority?: number; }; export default function useKeyboardEvents({ ignoreUsedKeyboardEvents, onKeyDown, onKeyPress, onKeyUp, priority, }: Props): void;