Skip to main content

useToggleShortcut

Interfaces

UseToggleShortcutOutput

Defined in: manager/hooks/useToggleShortcut.ts:4

Properties

PropertyTypeDescriptionDefined in
setToggleShortcutDispatch<SetStateAction<undefined | string>>Setter for the toggle shortcut state.manager/hooks/useToggleShortcut.ts:8
toggleShortcut?stringThe current toggle shortcut.manager/hooks/useToggleShortcut.ts:6

Functions

default()

default(initialToggleShortcut?): UseToggleShortcutOutput

Defined in: manager/hooks/useToggleShortcut.ts:20

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

ParameterTypeDescription
initialToggleShortcut?stringThe initial toggle shortcut to use.

Returns

UseToggleShortcutOutput