Hotkeys

Hotkeys are a series of one or several keys that trigger an action when pressed.

Props#

useHotkeys accepts a string or array of strings string[] and a callback function (e: KeyboardEvent) => void

useHotkeysShortcut accepts a string with the shortcut or a key combination and a callback function (e: KeyboardEvent) => void

Prop	Type	Description
callback`required`	`() => void`	Callback to be called when the key combination is pressed
children`required`	`type ONLY_FOR_FORMAT = \| string \| ReactElement<any, string \| JSXElementConstructor<any>> \| ((props: { keys: string \| string[] ariaKeyshortcuts?: string \| undefined }) => ReactNode)`	A single child or render prop function
command`required`	`string \| string[]`	The key combination. Supports shorthands: ⌥ ⇧ ⌃ ⌘ Shifted keys like ? and + are handled automatically
hotkeyOptions	`UseHotkeysOptions`	Options for the useHotkeys hook

Prop	Type	Default	Description
hotkeys`required`	`HotkeysConfig`

Was this helpful?