Hotkeys API Reference

HotkeyMeta

Metadata for hotkey registrations, chords and sequences alike. Includes name, description, and group by default. Extend via declaration merging:

Example

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

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

optional description?: string;

optional description?: string;

Description of what this hotkey does

optional group?: string;

optional group?: string;

Optional display group. Does not affect matching or scope.

optional name?: string;

optional name?: string;

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