defineAppHotkeys | TanStack Hotkeys Docs

function defineAppHotkeys<T>(definitions): DefinedAppHotkeys<T>;

function defineAppHotkeys<T>(definitions): DefinedAppHotkeys<T>;

Defined in: app-hotkeys.ts:178

Declares every app hotkey up front, without registering any, so cheat sheets and settings screens can list hotkeys whose components have not mounted. Pass the result to HotkeysProvider as appHotkeys.

Type Parameters

T

T extends Record<string, AppHotkeyInput>

Parameters

definitions

T & ValidatedAppHotkeyInputs<T>

Returns

DefinedAppHotkeys<T>

Example

export const appHotkeys = defineAppHotkeys({
  'doc.save': { hotkey: 'Mod+S', meta: { name: 'Save', group: 'Document' } },
  'nav.home': { hotkey: ['G', 'H'], meta: { name: 'Go home' }, options: { timeout: 800 } },
  'palette.open': { hotkey: null, meta: { name: 'Command palette' } },
})

export const appHotkeys = defineAppHotkeys({
  'doc.save': { hotkey: 'Mod+S', meta: { name: 'Save', group: 'Document' } },
  'nav.home': { hotkey: ['G', 'H'], meta: { name: 'Go home' }, options: { timeout: 800 } },
  'palette.open': { hotkey: null, meta: { name: 'Command palette' } },
})