UseCustomHotkeysResult

Defined in: appHotkeys.ts:61

Custom hotkey state and actions returned by useCustomHotkeys.

Properties#

customHotkeys#

customHotkeys: () => CustomHotkeys;

Defined in: appHotkeys.ts:63

The user's hotkeys that differ from the defaults.

Returns#

CustomHotkeys

findConflicts#

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

Defined in: appHotkeys.ts:77

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: appHotkeys.ts:73

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys#

resetCustomHotkeys: () => void;

Defined in: appHotkeys.ts:75

Restores every default hotkey.

Returns#

void

setCustomHotkey#

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

Defined in: appHotkeys.ts:68

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>[]