Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Hotkeys API Reference
App Hotkeys API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Normalization & format API Reference
App Hotkeys API Reference

AppHotkeyInput

Defined in: app-hotkeys.ts:46

One declaration passed to defineAppHotkeys.

Properties

hotkey

ts
hotkey: Hotkey | null;
hotkey: Hotkey | null;

Defined in: app-hotkeys.ts:48

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


meta?

ts
optional meta?: HotkeyMeta;
optional meta?: HotkeyMeta;

Defined in: app-hotkeys.ts:50

Display metadata for cheat sheets and settings screens.


options?

ts
optional options?: AppHotkeyOptions;
optional options?: AppHotkeyOptions;

Defined in: app-hotkeys.ts:62

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


scope?

ts
optional scope?: string;
optional scope?: string;

Defined in: app-hotkeys.ts:57

Scope this hotkey fires in, such as 'editor'. Overrides the scope of the provider it registers under. App hotkeys in different scopes may share a hotkey; one in the 'global' scope conflicts with any app hotkey that shares its hotkey.