UseCustomHotkeysResult | TanStack Hotkeys React Docs

Custom hotkey state and actions returned by useCustomHotkeys.

Properties

customHotkeys: CustomHotkeys;

customHotkeys: CustomHotkeys;

The user's hotkeys that differ from the defaults.

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

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

resetCustomHotkey: (id) => void;

resetCustomHotkey: (id) => void;

Restores the default hotkey for an app hotkey.

string

void

resetCustomHotkeys: () => void;

resetCustomHotkeys: () => void;

Restores every default hotkey.

void

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

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