TanStack
Hotkeys API Reference

InjectHotkeyDefinition

Interface: InjectHotkeyDefinition

Defined in: injectHotkeys.ts:19

A single hotkey definition for use with injectHotkeys.

Properties

callback

ts
callback: HotkeyCallback;

Defined in: injectHotkeys.ts:23

The function to call when the hotkey is pressed


hotkey

ts
hotkey: RegisterableHotkey | () => RegisterableHotkey;

Defined in: injectHotkeys.ts:21

The hotkey string (e.g., 'Mod+S', 'Escape') or RawHotkey object


options?

ts
optional options: 
  | InjectHotkeyOptions
  | () => InjectHotkeyOptions;

Defined in: injectHotkeys.ts:25

Per-hotkey options (merged on top of commonOptions)