HotkeyRegistrationHandle

Defined in: hotkey-manager.ts:261

A handle returned from HotkeyManager.register() that allows updating the callback and options without re-registering the hotkey.

Example

const handle = manager.register('Mod+S', callback, options)

// Update callback without re-registering (avoids stale closures)
handle.callback = newCallback

// Update options without re-registering
handle.setOptions({ enabled: false })

// Unregister when done
handle.unregister()

const handle = manager.register('Mod+S', callback, options)

// Update callback without re-registering (avoids stale closures)
handle.callback = newCallback

// Update options without re-registering
handle.setOptions({ enabled: false })

// Unregister when done
handle.unregister()

Type Parameters

TOptions

TOptions extends HotkeyOptions = | HotkeyChordOptions | HotkeySequenceOptions

Properties

callback

callback: HotkeyCallback;

callback: HotkeyCallback;

Defined in: hotkey-manager.ts:268

The callback function. Can be set directly to update without re-registering. This avoids stale closures when the callback references React state.

id

readonly id: string;

readonly id: string;

Defined in: hotkey-manager.ts:270

Unique identifier for this registration

isActive

readonly isActive: boolean;

readonly isActive: boolean;

Defined in: hotkey-manager.ts:272

Check if this registration is still active (not unregistered)

setOptions

setOptions: (options) => void;

setOptions: (options) => void;

Defined in: hotkey-manager.ts:280

Update options (merged with existing options). Useful for updating enabled, preventDefault, etc. without re-registering. Changing capture moves the listener phase without clearing requireReset state or sequence progress. A registration already processed for an event cannot process it again in another phase.

Parameters

options

Partial<TOptions>

Returns

void

unregister

unregister: () => void;

unregister: () => void;

Defined in: hotkey-manager.ts:282

Unregister this hotkey

Returns

void