useShortcuts

useShortcuts is a hook that binds keyboard shortcuts to callbacks, such as opening search with Cmd+K or closing a panel with Escape.

Import

import { useShortcuts } from '@vortexlabs/vortex';

Allied components

Other links

useShortcuts parameters
Prop	Type	Default
`shortcuts`	`object`	No default value
`deps`	`unknown[]`	`[]`
`options.ref`	`ref`	No default value
`options.disabled`	`boolean`	`false`
`options.preventDefault`	`boolean`	`false`

useShortcuts return value
Prop	Type	Default	Attributes
`ref`	`ref`	No default value
`checkShortcutState`	`callback`	No default value