useToggleShortcut
Interfaces
UseToggleShortcutOutput
Properties
Property | Type | Description | Defined in |
---|---|---|---|
setToggleShortcut | Dispatch <SetStateAction <null | string >> | Setter for the toggle shortcut state. | manager/hooks/useToggleShortcut.ts:8 |
toggleShortcut | null | string | The current toggle shortcut. | manager/hooks/useToggleShortcut.ts:6 |
Functions
default()
default(
initialToggleShortcut
):UseToggleShortcutOutput
The hook for managing the toggle shortcut.
This hook is responsible for registering and unregistering the toggle shortcut on shortcut change. Just use the setter it returns to change the toggle shortcut and it will handle the rest.
Parameters
Parameter | Type | Description |
---|---|---|
initialToggleShortcut | null | string | The initial toggle shortcut to use. |