Skip to main content

Function: ariaKeyShortcut()

ariaKeyShortcut(combo, platform?): string

Defined in: src/lib/utils/shortcuts/index.ts:424

A key combination as an aria-keyshortcuts value, so screen readers can announce it.

Parameters​

combo​

KeyCombo

platform?​

string

Returns​

string

Example​

ariaKeyShortcut({ key: "s", cmd: true }, "MacIntel"); // "Meta+S"
ariaKeyShortcut({ key: "backspace", alt: true }, "Win32"); // "Alt+Backspace"