HotkeyRecorder | TanStack Hotkeys Docs

Framework-agnostic class for recording keyboard shortcuts.

With the default maxSteps: 1, the first valid chord commits. With a larger maxSteps, each chord adds a step; the recording commits on Enter (unless commitKeys: 'none'), after idleTimeoutMs, or when it reaches maxSteps. Backspace/Delete removes the last step, and on an empty recording calls onClear. Escape cancels. A one-step result is a chord string.

State Management:

Uses TanStack Store for reactive state management
State can be accessed via recorder.store.state when using the class directly
When using framework adapters, use the useHotkeyRecorder hook for reactive state

Example

const recorder = new HotkeyRecorder({
  onRecord: (hotkey) => {
    console.log('Recorded:', hotkey) // 'Mod+S'
  },
})

const sequenceRecorder = new HotkeyRecorder({
  maxSteps: Infinity,
  onRecord: (hotkey) => {
    console.log('Recorded:', hotkey) // 'Mod+S' or ['G', 'H']
  },
})

recorder.start()
// ... later
recorder.destroy()

const recorder = new HotkeyRecorder({
  onRecord: (hotkey) => {
    console.log('Recorded:', hotkey) // 'Mod+S'
  },
})

const sequenceRecorder = new HotkeyRecorder({
  maxSteps: Infinity,
  onRecord: (hotkey) => {
    console.log('Recorded:', hotkey) // 'Mod+S' or ['G', 'H']
  },
})

recorder.start()
// ... later
recorder.destroy()

Constructors

Constructor

new HotkeyRecorder(options): HotkeyRecorder;

new HotkeyRecorder(options): HotkeyRecorder;

Defined in: hotkey-recorder.ts:217

Parameters

options

| HotkeyChordRecorderOptions | (() => HotkeyChordRecorderOptions)

Returns

HotkeyRecorder

Constructor

new HotkeyRecorder(options): HotkeyRecorder;

new HotkeyRecorder(options): HotkeyRecorder;

Defined in: hotkey-recorder.ts:220

Parameters

options

| HotkeySequenceRecorderOptions | (() => HotkeySequenceRecorderOptions)

Returns

HotkeyRecorder

Properties

store

readonly store: Store<HotkeyRecorderState>;

readonly store: Store<HotkeyRecorderState>;

Defined in: hotkey-recorder.ts:193

Methods

cancel()

cancel(): void;

cancel(): void;

Defined in: hotkey-recorder.ts:475

Cancel recording without saving.

Removes the event listener, resets the recording state, and calls the onCancel callback if provided.

Returns

void

commit()

commit(): void;

commit(): void;

Defined in: hotkey-recorder.ts:381

Commits the recorded steps after validation and conflict checks. Called automatically at maxSteps, on Enter, or after idleTimeoutMs. A rejected commit leaves recording active with its steps intact.