keyboard

Keyboard event helpers — key and modifier checks, printable-key detection, multi-key shortcuts, and preventing default for a specific key.

Import: @rtorcato/browser-common/keyboard

📖 MDN: KeyboardEvent

Browser support

API	Chrome	Edge	Firefox	Safari	iOS Safari	Baseline
KeyboardEvent.key	✅ 51+ [1]	✅ 12+	✅ 23+	✅ 10.1+	✅ 10.3+	Widely available

1. Chrome: When selecting an autocomplete suggestion, a keydown event fires where the event's key property is undefined. See bug 41425904.

✅ supported · ◐ partial · ❌ not supported · [n] see note. Generated from MDN browser-compat-data and web-features. caniuse: KeyboardEvent.key

Example

import { onShortcut, isKey } from '@rtorcato/browser-common/keyboard'

const off = onShortcut(['Control', 's'], (event) => {
  event.preventDefault()
  save()
})

input.addEventListener('keydown', (e) => {
  if (isKey(e, 'Enter')) submit()
})

off()

Exports

• isKey(event, key) — case-insensitive match against event.key
• isModifierKey(event) — true for Shift, Control, Alt, or Meta
• isPrintableKey(event) — true for a single printable character (no Ctrl/Meta)
• onShortcut(keys, callback, target?) — fires when all keys are held together; returns an unsubscribe function
• preventKeyDefault(key, target?) — calls preventDefault() whenever key is pressed; returns an unsubscribe function

See the API reference for full signatures.