InjectCustomHotkeysResult

Defined in: injectAppHotkeys.ts:63

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:65

The user's hotkeys that differ from the defaults.

findConflicts#

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

Defined in: injectAppHotkeys.ts:79

Other app hotkeys that would collide if id used hotkey.

Parameters#

id#

string

hotkey#

Hotkey

Returns#

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

resetCustomHotkey#

readonly resetCustomHotkey: (id) => void;

Defined in: injectAppHotkeys.ts:75

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys#

readonly resetCustomHotkeys: () => void;

Defined in: injectAppHotkeys.ts:77

Restores every default hotkey.

Returns#

void

setCustomHotkey#

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

Defined in: injectAppHotkeys.ts:70

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