Hotkey Sequence API Reference

SequenceManager

Class: SequenceManager

Defined in: sequence-manager.ts:148

Properties

registrations

ts
readonly registrations: Store<Map<string, SequenceRegistrationView>>;

Defined in: sequence-manager.ts:155

The TanStack Store containing sequence registration views for devtools. Subscribe to this to observe registration changes.

Methods

destroy()

ts
destroy(): void;

Defined in: sequence-manager.ts:597

Destroys the manager and removes all listeners.

Returns

void


getRegistrationCount()

ts
getRegistrationCount(): number;

Defined in: sequence-manager.ts:590

Gets the number of registered sequences.

Returns

number


register()

ts
register(
   sequence, 
   callback, 
   options): SequenceRegistrationHandle;

Defined in: sequence-manager.ts:201

Registers a hotkey sequence handler.

Parameters

sequence

HotkeySequence

Array of hotkey strings that form the sequence

callback

HotkeyCallback

Function to call when the sequence is completed

options

SequenceOptions = {}

Options for the sequence behavior

Returns

SequenceRegistrationHandle

A handle to update or unregister the sequence


resetAll()

ts
resetAll(): void;

Defined in: sequence-manager.ts:532

Resets all sequence progress.

Returns

void


triggerSequence()

ts
triggerSequence(id): boolean;

Defined in: sequence-manager.ts:546

Triggers a sequence's callback programmatically from devtools. Creates a synthetic KeyboardEvent from the last key in the sequence.

Parameters

id

string

The registration ID to trigger

Returns

boolean

True if the registration was found and triggered


getInstance()

ts
static getInstance(): SequenceManager;

Defined in: sequence-manager.ts:176

Gets the singleton instance of SequenceManager.

Returns

SequenceManager


resetInstance()

ts
static resetInstance(): void;

Defined in: sequence-manager.ts:186

Resets the singleton instance. Useful for testing.

Returns

void