HotkeyMeta

Defined in: hotkey.types.ts:252

Metadata for hotkey and sequence registrations. 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:256

Description of what this hotkey does

group?#

optional group: string;

Defined in: hotkey.types.ts:258

Optional display group. Does not affect matching or scope.

name?#

optional name: string;

Defined in: hotkey.types.ts:254

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