createHotkeyBindings

function createHotkeyBindings(adapterOptions?): object;

Defined in: adapter.ts:78

Reconciles adapter registrations while retaining handles for option updates. Adapters for frameworks that delegate key events, such as React, pass { afterDelegatedHandlers: true }.

Parameters#

adapterOptions?#

Pick<HotkeyOptions, "afterDelegatedHandlers"> = {}

Returns#

destroy()#

destroy(): void;

Returns#

void

update()#

update(definitions, commonOptions?): void;

Registers new definitions, updates existing ones in place, and removes stale ones. Definitions with no hotkey (undefined, null, empty string, or empty sequence) or a null target are skipped.

Parameters#

definitions#

readonly HotkeyDefinition[]

commonOptions?#

HotkeyBindingsCommonOptions = {}

Returns#

void