Skip to main content

useShortcuts

Hook for binding keyboard shortcuts to callbacks and reading whether specific key combinations are currently pressed.

Component properties
PropTypeDefaultAttributes
shortcuts
object
No default value
deps
unknown[]
[]
options.ref
React.RefObject<HTMLElement | null>
No default value
options.disabled
boolean
No default value
options.preventDefault
boolean
No default value

Return value

Component properties
PropTypeDefaultAttributes
ref
React.RefObject<Element>
No default value
checkShortcutState
function
No default value