Skip to content
Hotkeys API Reference

createHotkeyRecorder

Call Signature

ts
function createHotkeyRecorder(owner, options): AlpineHotkeyRecorder<HotkeyChord>;

Defined in: createHotkeyRecorder.ts:18

Creates a recorder owned by a createHotkeysScope owner. It uses the owner's hotkeyRecorder defaults, and options can follow Alpine state. maxSteps (default 1) selects chords or sequences.

Parameters

owner

AlpineHotkeys

options

HotkeyChordRecorderOptions

Returns

AlpineHotkeyRecorder<HotkeyChord>

Call Signature

ts
function createHotkeyRecorder(owner, options): AlpineHotkeyRecorder;

Defined in: createHotkeyRecorder.ts:22

Creates a recorder owned by a createHotkeysScope owner. It uses the owner's hotkeyRecorder defaults, and options can follow Alpine state. maxSteps (default 1) selects chords or sequences.

Parameters

owner

AlpineHotkeys

options

HotkeySequenceRecorderOptions

Returns

AlpineHotkeyRecorder

Call Signature

ts
function createHotkeyRecorder(owner, options): AlpineHotkeyRecorder;

Defined in: createHotkeyRecorder.ts:28

Creates a recorder owned by a createHotkeysScope owner. It uses the owner's hotkeyRecorder defaults, and options can follow Alpine state. maxSteps (default 1) selects chords or sequences.

Parameters

owner

AlpineHotkeys

options

() => HotkeySequenceRecorderOptions

Returns

AlpineHotkeyRecorder

Call Signature

ts
function createHotkeyRecorder(owner, options): AlpineHotkeyRecorder<HotkeyChord>;

Defined in: createHotkeyRecorder.ts:32

Creates a recorder owned by a createHotkeysScope owner. It uses the owner's hotkeyRecorder defaults, and options can follow Alpine state. maxSteps (default 1) selects chords or sequences.

Parameters

owner

AlpineHotkeys

options

() => HotkeyChordRecorderOptions

Returns

AlpineHotkeyRecorder<HotkeyChord>

Call Signature

ts
function createHotkeyRecorder(owner, options): AlpineHotkeyRecorder;

Defined in: createHotkeyRecorder.ts:36

Creates a recorder owned by a createHotkeysScope owner. It uses the owner's hotkeyRecorder defaults, and options can follow Alpine state. maxSteps (default 1) selects chords or sequences.

Parameters

owner

AlpineHotkeys

options

() => HotkeyRecorderOptions

Returns

AlpineHotkeyRecorder