UseCustomHotkeysResult

Defined in: appHotkeys.ts:67

Custom hotkey state and actions returned by useCustomHotkeys.

Properties#

customHotkeys#

customHotkeys: () => CustomHotkeys;

Defined in: appHotkeys.ts:69

The user's hotkeys that differ from the defaults.

Returns#

CustomHotkeys

findConflicts#

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

Defined in: appHotkeys.ts:89

Other app hotkeys that would collide if id used hotkey. Pass the recorder's context for a recorded hotkey: it has the key press, which also finds a hotkey written differently that the same press fires.

Parameters#

id#

string

hotkey#

Hotkey

recordedWith?#

RecordedKeyPresses

Returns#

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

resetCustomHotkey#

resetCustomHotkey: (id) => void;

Defined in: appHotkeys.ts:81

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys#

resetCustomHotkeys: () => void;

Defined in: appHotkeys.ts:83

Restores every default hotkey.

Returns#

void

setCustomHotkey#

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

Defined in: appHotkeys.ts:75

Sets the user's hotkey for an app hotkey. null unbinds it. Returns conflicting app hotkeys; when any exist, nothing changes. Pass the recorder's context for a recorded hotkey, as for findConflicts.

Parameters#

id#

string

hotkey#

Hotkey | null

recordedWith?#

RecordedKeyPresses

Returns#

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