Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Hotkeys API Reference
Hotkey Sequence API Reference
Key Hold API Reference
Held Keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Format for Display API Reference
Hotkeys API Reference

UseHotkeyDefinition

Interface: UseHotkeyDefinition

Defined in: packages/vue-hotkeys/src/useHotkeys.ts:21

A single hotkey definition for use with useHotkeys.

Properties

callback

ts
callback: HotkeyCallback;

Defined in: packages/vue-hotkeys/src/useHotkeys.ts:25

The function to call when the hotkey is pressed


hotkey

ts
hotkey: MaybeRefOrGetter<RegisterableHotkey>;

Defined in: packages/vue-hotkeys/src/useHotkeys.ts:23

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


options?

ts
optional options: MaybeRefOrGetter<UseHotkeyOptions>;

Defined in: packages/vue-hotkeys/src/useHotkeys.ts:27

Per-hotkey options (merged on top of commonOptions)