useHotkeyRecorder

Call Signature#

function useHotkeyRecorder(options): VueHotkeyRecorder<HotkeyChord>;

Defined in: useHotkeyRecorder.ts:47

Vue composable for recording keyboard shortcuts. Options may be a ref or getter.

With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

options#

HotkeyChordRecorderOptions

Returns#

VueHotkeyRecorder<HotkeyChord>

Example#

const recorder = useHotkeyRecorder({ onRecord: (hotkey) => (shortcut.value = hotkey) })
const sequenceRecorder = useHotkeyRecorder({ maxSteps: Infinity, onRecord: save })

Call Signature#

function useHotkeyRecorder(options): VueHotkeyRecorder;

Defined in: useHotkeyRecorder.ts:50

Vue composable for recording keyboard shortcuts. Options may be a ref or getter.

With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

options#

HotkeySequenceRecorderOptions

Returns#

VueHotkeyRecorder

Example#

const recorder = useHotkeyRecorder({ onRecord: (hotkey) => (shortcut.value = hotkey) })
const sequenceRecorder = useHotkeyRecorder({ maxSteps: Infinity, onRecord: save })

Call Signature#

function useHotkeyRecorder(options): VueHotkeyRecorder;

Defined in: useHotkeyRecorder.ts:55

Vue composable for recording keyboard shortcuts. Options may be a ref or getter.

With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

options#

() => HotkeySequenceRecorderOptions

Returns#

VueHotkeyRecorder

Example#

const recorder = useHotkeyRecorder({ onRecord: (hotkey) => (shortcut.value = hotkey) })
const sequenceRecorder = useHotkeyRecorder({ maxSteps: Infinity, onRecord: save })

Call Signature#

function useHotkeyRecorder(options): VueHotkeyRecorder<HotkeyChord>;

Defined in: useHotkeyRecorder.ts:58

Vue composable for recording keyboard shortcuts. Options may be a ref or getter.

With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

options#

() => HotkeyChordRecorderOptions

Returns#

VueHotkeyRecorder<HotkeyChord>

Example#

const recorder = useHotkeyRecorder({ onRecord: (hotkey) => (shortcut.value = hotkey) })
const sequenceRecorder = useHotkeyRecorder({ maxSteps: Infinity, onRecord: save })

Call Signature#

function useHotkeyRecorder(options): VueHotkeyRecorder;

Defined in: useHotkeyRecorder.ts:61

Vue composable for recording keyboard shortcuts. Options may be a ref or getter.

With the default maxSteps: 1, the first valid chord is recorded. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or at maxSteps, and onRecord receives a chord (one step) or a sequence.

Parameters#

options#

Ref<HotkeyRecorderOptions>

Returns#

VueHotkeyRecorder

Example#

const recorder = useHotkeyRecorder({ onRecord: (hotkey) => (shortcut.value = hotkey) })
const sequenceRecorder = useHotkeyRecorder({ maxSteps: Infinity, onRecord: save })