TanStack

HotkeyChordRegistration

Defined in: hotkey-manager.ts:190

A registered chord in the HotkeyManager.

Extends

Properties

activeMatch?

ts
optional activeMatch?: object;

Defined in: hotkey-manager.ts:195

The concrete key/code that activated a requireReset registration.

code

ts
code: string;

key

ts
key: string;

callback

ts
callback: HotkeyCallback;

Defined in: hotkey-manager.ts:178

The callback to invoke

Inherited from

ts
RegistrationBase.callback

hasFired

ts
hasFired: boolean;

Defined in: hotkey-manager.ts:186

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

Inherited from

ts
RegistrationBase.hasFired

hotkey

ts
hotkey: HotkeyChord;

Defined in: hotkey-manager.ts:192


id

ts
id: string;

Defined in: hotkey-manager.ts:176

Unique identifier for this registration

Inherited from

ts
RegistrationBase.id

kind

ts
kind: "chord";

Defined in: hotkey-manager.ts:191


options

ts
options: HotkeyChordOptions;

Defined in: hotkey-manager.ts:180

Resolved options for this registration

Inherited from

ts
RegistrationBase.options

parsedChord

ts
parsedChord: ParsedHotkeyChord;

Defined in: hotkey-manager.ts:193


target

ts
target: Target;

Defined in: hotkey-manager.ts:182

The resolved target element for this registration

Inherited from

ts
RegistrationBase.target

triggerCount

ts
triggerCount: number;

Defined in: hotkey-manager.ts:184

How many times this registration's callback has been triggered

Inherited from

ts
RegistrationBase.triggerCount