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
App Hotkeys API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Normalization & format API Reference
Hotkeys API Reference

HotkeysContextValue

Defined in: hotkeys-provider.ts:72

Properties

appHotkeysState

ts
readonly appHotkeysState: Signal<
  | AppHotkeysState<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
| null>;
readonly appHotkeysState: Signal<
  | AppHotkeysState<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
| null>;

Defined in: hotkeys-provider.ts:79

Tracks app hotkeys and custom hotkeys so signals and effects re-run.


appHotkeysStore

ts
readonly appHotkeysStore: 
  | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
  | null;
readonly appHotkeysStore: 
  | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
  | null;

Defined in: hotkeys-provider.ts:77


defaultOptions

ts
readonly defaultOptions: HotkeysProviderOptions;
readonly defaultOptions: HotkeysProviderOptions;

Defined in: hotkeys-provider.ts:74

Merged with every ancestor provider's defaults, including hotkey.scope.


enabled

ts
readonly enabled: Signal<boolean>;
readonly enabled: Signal<boolean>;

Defined in: hotkeys-provider.ts:76

Whether this provider and every ancestor are enabled.