Skip to content
Hotkeys API Reference

HotkeysProviderOptions

Defined in: HotkeysProvider.tsx:22

Properties

hotkey?

ts
optional hotkey?: UseHotkeyCommonOptions;

Defined in: HotkeysProvider.tsx:33

Defaults for every hotkey registered by useHotkey and useHotkeys. requireReset applies to chords and timeout applies to sequences.


hotkeyRecorder?

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

Defined in: HotkeysProvider.tsx:35

Defaults for every useHotkeyRecorder.


platform?

ts
optional platform?: HotkeyPlatform;

Defined in: HotkeysProvider.tsx:28

The user's platform, for labels from useFormatForDisplay, hotkeys, and recorders. Defaults to detection. When server rendering, set it from the request with detectPlatform(userAgent).