Interface: HotkeyMeta#

Defined in: hotkey.ts:431

Metadata for hotkey and sequence registrations. Includes name and description 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.ts:435

Description of what this hotkey does

name?#

optional name: string;

Defined in: hotkey.ts:433

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