Hotkeys API Reference

HotkeyCallback

Type Alias: HotkeyCallback()

type HotkeyCallback = (event, context) => void;

type HotkeyCallback = (event, context) => void;

Defined in: hotkey.ts:412

Callback function type for hotkey handlers.

Parameters

event

KeyboardEvent

The keyboard event that triggered the hotkey

context

HotkeyCallbackContext

Additional context including the hotkey and parsed hotkey

Returns

void

Example

const handler: HotkeyCallback = (event, { hotkey, parsedHotkey }) => {
  console.log(`Hotkey ${hotkey} was pressed`)
  console.log(`Modifiers:`, parsedHotkey.modifiers)
}

const handler: HotkeyCallback = (event, { hotkey, parsedHotkey }) => {
  console.log(`Hotkey ${hotkey} was pressed`)
  console.log(`Modifiers:`, parsedHotkey.modifiers)
}