Skip to content

DefaultHotkeysOptions

Defined in: types.ts:205

Shared defaults; call-specific options take precedence.

Properties

hotkey?

ts
optional hotkey?: AlpineHotkeyCommonOptions;

Defined in: types.ts:221

Defaults for every hotkey. requireReset applies to chords and timeout to sequences.


hotkeyRecorder?

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

Defined in: types.ts:223

Defaults for every recorder.


keyboardLayout?

ts
optional keyboardLayout?: boolean;

Defined in: types.ts:219

Whether labels from createFormatForDisplay follow the user's keyboard layout, so [KeyQ] reads A on a French AZERTY keyboard. The layout loads from the browser when the first createFormatForDisplay or createKeyboardLayout runs. Only Chromium browsers report one. Set false to never ask the browser for it. Default: true.


platform?

ts
optional platform?: HotkeyPlatform;

Defined in: types.ts:211

The user's platform, for labels from createFormatForDisplay, hotkeys, and recorders. hotkey.platform and hotkeyRecorder.platform win. Detected when unset.