parseKeyboardEvent

function parseKeyboardEvent(event, platform?): ParsedHotkey;

Defined in: parse.ts:300

Parses a KeyboardEvent into a ParsedHotkey object.

This function extracts the key and modifier state from a keyboard event and converts it into the same format used by parseHotkey().

Parameters#

event#

KeyboardEvent

The KeyboardEvent to parse

platform?#

"mac" | "windows" | "linux"

The target platform for resolving modifiers (defaults to auto-detection)

Returns#

ParsedHotkey

A ParsedHotkey object representing the keyboard event

Example#

document.addEventListener('keydown', (event) => {
  const parsed = parseKeyboardEvent(event)
  console.log(parsed) // { key: 'S', ctrl: true, shift: false, ... }
})