@rtorcato/browser-common / keyboard
keyboard
Functions
isKey()
isKey(
event,key):boolean
Defined in: keyboard/index.ts:12
Checks if a KeyboardEvent matches a given key (case-insensitive).
Example
import { isKey } from '@rtorcato/browser-common/keyboard'
input.addEventListener('keydown', (e) => { if (isKey(e, 'Enter')) submit() })
Parameters
event
KeyboardEvent
The KeyboardEvent.
key
string
The key to check (e.g., 'Enter', 'a').
Returns
boolean
isModifierKey()
isModifierKey(
event):boolean
Defined in: keyboard/index.ts:26
Checks if a KeyboardEvent is a modifier key (Shift, Ctrl, Alt, Meta).
Example
import { isModifierKey } from '@rtorcato/browser-common/keyboard'
window.addEventListener('keydown', (e) => { if (!isModifierKey(e)) handle(e) })
Parameters
event
KeyboardEvent
The KeyboardEvent.
Returns
boolean
isPrintableKey()
isPrintableKey(
event):boolean
Defined in: keyboard/index.ts:42
Returns true if the event is a printable character (not a control or modifier key).
Example
import { isPrintableKey } from '@rtorcato/browser-common/keyboard'
input.addEventListener('keydown', (e) => { if (isPrintableKey(e)) typeChar(e.key) })
Parameters
event
KeyboardEvent
The KeyboardEvent.
Returns
boolean
onShortcut()
onShortcut(
keys,callback,target?): () =>void
Defined in: keyboard/index.ts:59
Adds a keyboard shortcut listener to an element or the window.
Example
import { onShortcut } from '@rtorcato/browser-common/keyboard'
const off = onShortcut(['Control', 's'], (e) => { e.preventDefault(); save() })
off()
Parameters
keys
string[]
Array of keys (e.g., ['Control', 's'])
callback
(event) => void
Function to call when shortcut is pressed.
target?
HTMLElement | Window
The event target (default: window).
Returns
Unsubscribe function.
() => void
preventKeyDefault()
preventKeyDefault(
key,target?): () =>void
Defined in: keyboard/index.ts:98
Prevents default action for a given key (e.g., prevent form submit on Enter).
Example
import { preventKeyDefault } from '@rtorcato/browser-common/keyboard'
const off = preventKeyDefault('Enter', input)
off()
Parameters
key
string
The key to prevent.
target?
HTMLElement | Window
The event target (default: window).
Returns
Unsubscribe function.
() => void