InjectCustomHotkeysResult

Defined in: injectAppHotkeys.ts:64

Custom hotkey state and actions returned by injectCustomHotkeys.

Properties#

customHotkeys#

readonly customHotkeys: Signal<CustomHotkeys<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>>;

Defined in: injectAppHotkeys.ts:66

The user's hotkeys that differ from the defaults.

findConflicts#

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

Defined in: injectAppHotkeys.ts:86

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#

readonly resetCustomHotkey: (id) => void;

Defined in: injectAppHotkeys.ts:78

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys#

readonly resetCustomHotkeys: () => void;

Defined in: injectAppHotkeys.ts:80

Restores every default hotkey.

Returns#

void

setCustomHotkey#

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

Defined in: injectAppHotkeys.ts:72

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