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
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Hotkeys API Reference

HotkeyMeta

Interface: HotkeyMeta

Defined in: hotkey.ts:431

Metadata for hotkey and sequence registrations. Includes name and description by default. Extend via declaration merging:

Example

ts
declare module '@tanstack/hotkeys' {
  interface HotkeyMeta {
    category?: string
    icon?: string
  }
}

Properties

description?

ts
optional description: string;

Defined in: hotkey.ts:435

Description of what this hotkey does


name?

ts
optional name: string;

Defined in: hotkey.ts:433

Human-readable name for this hotkey (e.g., "Save Document")