HotkeyChordRegistration | TanStack Hotkeys Docs

A registered chord in the HotkeyManager.

Extends

optional activeMatch?: object;

optional activeMatch?: object;

The concrete key/code that activated a requireReset registration.

code: string;

code: string;

key: string;

key: string;

callback: HotkeyCallback;

callback: HotkeyCallback;

The callback to invoke

RegistrationBase.callback

RegistrationBase.callback

hasFired: boolean;

hasFired: boolean;

Whether this registration has fired (and, for requireReset chords, needs a reset)

RegistrationBase.hasFired

RegistrationBase.hasFired

hotkey: HotkeyChord;

hotkey: HotkeyChord;

id: string;

id: string;

Unique identifier for this registration

RegistrationBase.id

RegistrationBase.id

kind: "chord";

kind: "chord";

options: HotkeyChordOptions;

options: HotkeyChordOptions;

Resolved options for this registration

RegistrationBase.options

RegistrationBase.options

parsedChord: ParsedHotkeyChord;

parsedChord: ParsedHotkeyChord;

target: Target;

target: Target;

The resolved target element for this registration

RegistrationBase.target

RegistrationBase.target

triggerCount: number;

triggerCount: number;

How many times this registration's callback has been triggered

RegistrationBase.triggerCount

RegistrationBase.triggerCount