InjectCustomHotkeysResult | TanStack Hotkeys Angular Docs

Custom hotkey state and actions returned by injectCustomHotkeys.

Properties

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

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

The user's hotkeys that differ from the defaults.

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

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

Other app hotkeys that would collide if id used hotkey.

string

Hotkey

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

readonly resetCustomHotkey: (id) => void;

readonly resetCustomHotkey: (id) => void;

Restores the default hotkey for an app hotkey.

string

void

readonly resetCustomHotkeys: () => void;

readonly resetCustomHotkeys: () => void;

Restores every default hotkey.

void

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

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

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

string

Hotkey | null

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