HotkeyRegistrationHandle

Defined in: hotkey-manager.ts:219

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()

Type Parameters#

TOptions#

TOptions extends HotkeyOptions = | HotkeyChordOptions | HotkeySequenceOptions

Properties#

callback#

callback: HotkeyCallback;

Defined in: hotkey-manager.ts:226

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;

Defined in: hotkey-manager.ts:228

Unique identifier for this registration

isActive#

readonly isActive: boolean;

Defined in: hotkey-manager.ts:230

Check if this registration is still active (not unregistered)

setOptions#

setOptions: (options) => void;

Defined in: hotkey-manager.ts:235

Update options (merged with existing options). Useful for updating enabled, preventDefault, etc. without re-registering.

Parameters#

options#

Partial<TOptions>

Returns#

void

unregister#

unregister: () => void;

Defined in: hotkey-manager.ts:237

Unregister this hotkey

Returns#

void