TanStack
App Hotkeys API Reference

AppHotkeyInput

Defined in: app-hotkeys.ts:44

One declaration passed to defineAppHotkeys.

Properties

context?

ts
optional context?: string;

Defined in: app-hotkeys.ts:54

Label for where this hotkey applies, such as 'editor'. App hotkeys with different contexts may share a hotkey; one without a context conflicts with any app hotkey that shares its hotkey. It does not affect matching.


hotkey

ts
hotkey: Hotkey | null;

Defined in: app-hotkeys.ts:46

Default hotkey: a chord, a sequence, or null for an action without a default.


meta?

ts
optional meta?: HotkeyMeta;

Defined in: app-hotkeys.ts:48

Display metadata for cheat sheets and settings screens.


options?

ts
optional options?: AppHotkeyOptions;

Defined in: app-hotkeys.ts:59

Options that describe the hotkey itself. Chord defaults accept requireReset; sequence defaults accept timeout.