UseCustomHotkeysResult

Defined in: types.ts:35

Custom hotkey state and actions returned by useCustomHotkeys.

Properties#

customHotkeys#

customHotkeys: CustomHotkeys;

Defined in: types.ts:37

The user's hotkeys that differ from the defaults.

findConflicts#

findConflicts: (id, hotkey) => AppHotkey<string, HotkeyChord | HotkeySequence | null>[];

Defined in: types.ts:51

Other app hotkeys that would collide if id used hotkey.

Parameters#

id#

string

hotkey#

Hotkey

Returns#

AppHotkey<string, HotkeyChord | HotkeySequence | null>[]

resetCustomHotkey#

resetCustomHotkey: (id) => void;

Defined in: types.ts:47

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys#

resetCustomHotkeys: () => void;

Defined in: types.ts:49

Restores every default hotkey.

Returns#

void

setCustomHotkey#

setCustomHotkey: (id, hotkey) => AppHotkey<string, HotkeyChord | HotkeySequence | null>[];

Defined in: types.ts:42

Sets the user's hotkey for an app hotkey. null unbinds it. Returns conflicting app hotkeys; when any exist, nothing changes.

Parameters#

id#

string

hotkey#

Hotkey | null

Returns#

AppHotkey<string, HotkeyChord | HotkeySequence | null>[]