Skip to content
Hotkeys API Reference

HotkeysProviderOptions

Defined in: hotkeys-provider.ts:32

Properties

hotkey?

ts
optional hotkey?: InjectHotkeyCommonOptions;

Defined in: hotkeys-provider.ts:43

Defaults for every hotkey registered by injectHotkey and injectHotkeys. requireReset applies to chords and timeout applies to sequences.


hotkeyRecorder?

ts
optional hotkeyRecorder?: Partial<Omit<HotkeyChordRecorderOptions & HotkeySequenceRecorderOptions, "maxSteps" | "validate" | "onRecord">>;

Defined in: hotkeys-provider.ts:45

Defaults for every injectHotkeyRecorder.


platform?

ts
optional platform?: HotkeyPlatform;

Defined in: hotkeys-provider.ts:38

The user's platform, for labels from injectFormatForDisplay, hotkeys, and recorders. Detected when unset. On a server, set it from the request with detectPlatform(userAgent).