runHotkeys

runHotkeys<T>(e, map, data): true | undefined

Defined in: extensions/commands/utils.ts:96

Utility that runs all commands whose key matches the keyboard event until a command returns a truthy value. In that case preventDefault and stopImmediatePropagation are called.

Type Parameters

T

T

Parameters

e

KeyboardEvent

Keyboard event to run commands for.

map

HotkeyMap<T>

Record mapping keys to a list of commands for that key.

data

T

Argument to pass to the commands.

Returns

true | undefined

true if a command returned a truthy value.

Example

addEventListener("keydown", e => {
  const handled = !!runHotkeys(e, map, data)
})