Docs
Cloudflare
Railway
CodeRabbit
OpenRouter
WorkOS
AG Grid
Clerk
SerpAPI
Netlify
Unkey
Prisma
Electric
Sentry
Cloudflare
Railway
CodeRabbit
OpenRouter
WorkOS
AG Grid
Clerk
SerpAPI
Netlify
Unkey
Prisma
Electric
Sentry
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Hotkeys API Reference

UseHotkeyDefinition

Interface: UseHotkeyDefinition

Defined in: useHotkeys.ts:20

A single hotkey definition for use with useHotkeys.

Properties

callback

ts
callback: HotkeyCallback;
callback: HotkeyCallback;

Defined in: useHotkeys.ts:24

The function to call when the hotkey is pressed


hotkey

ts
hotkey: RegisterableHotkey;
hotkey: RegisterableHotkey;

Defined in: useHotkeys.ts:22

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


options?

ts
optional options: UseHotkeyOptions;
optional options: UseHotkeyOptions;

Defined in: useHotkeys.ts:26

Per-hotkey options (merged on top of commonOptions)