TanStack
Hotkeys API Reference

HotkeyRegistration

Defined in: hotkey-manager.ts:61

A registered hotkey handler in the HotkeyManager.

Properties

activeMatch?

ts
optional activeMatch: object;

Defined in: hotkey-manager.ts:67

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

The callback to invoke


hasFired

ts
hasFired: boolean;

Defined in: hotkey-manager.ts:65

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


hotkey

ts
hotkey: Hotkey;

Defined in: hotkey-manager.ts:69

The original hotkey string


id

ts
id: string;

Defined in: hotkey-manager.ts:71

Unique identifier for this registration


options

ts
options: HotkeyOptions;

Defined in: hotkey-manager.ts:73

Options for this registration


parsedHotkey

ts
parsedHotkey: ParsedHotkey;

Defined in: hotkey-manager.ts:75

The parsed hotkey


target

ts
target: Document | Window | HTMLElement;

Defined in: hotkey-manager.ts:77

The resolved target element for this registration


triggerCount

ts
triggerCount: number;

Defined in: hotkey-manager.ts:79

How many times this registration's callback has been triggered