useKeyboard
React hooks for listen to multiple keyboard events.
General
Global keyboard events.
Element Event
keyboard events listening on elements.
APIs
useKeyboard
type KeyboardOptions = {
disableGlobalEvent: boolean,
stopPropagation: boolean
preventDefault: boolean
capture: boolean
event: 'keydown' | 'keypress' | 'keyup'
}
const useKeyboard = (
handler: (event: React.KeyboardEvent) => void,
keyBindings: Array<number> | number,
options?: KeyboardOptions,
) => void
KeyboardOptions
| Option | Description | Type | Accepted values | Default |
|---|---|---|---|---|
| disableGlobalEvent | disable global events from document | boolean | - | false |
| stopPropagation | stop event Propagation | boolean | - | false |
| preventDefault | block the default behavior of event | boolean | - | true |
| capture | set event type to "capture" | boolean | - | false |
| event | keyboard event type | string | 'keydown', 'keypress', 'keyup' | keydown |
Contributors