HotkeyMeta

Defined in: hotkey.types.ts:268

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
  }
}

Properties#

description?#

optional description?: string;

Defined in: hotkey.types.ts:272

Description of what this hotkey does

group?#

optional group?: string;

Defined in: hotkey.types.ts:274

Optional display group. Does not affect matching or scope.

name?#

optional name?: string;

Defined in: hotkey.types.ts:270

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