KEY_DISPLAY_SYMBOLS | TanStack Hotkeys English

const KEY_DISPLAY_SYMBOLS: object;

Defined in: display-labels.ts:112

Special key symbols for display formatting.

Maps certain keys to their visual symbols for better readability in hotkey displays. Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter instead of text labels.

Type Declaration

ArrowDown

readonly ArrowDown: "↓" = '↓';

ArrowLeft

readonly ArrowLeft: "←" = '←';

ArrowRight

readonly ArrowRight: "→" = '→';

ArrowUp

readonly ArrowUp: "↑" = '↑';

Backspace

readonly Backspace: "⌫" = '⌫';

Delete

readonly Delete: "⌦" = '⌦';

Enter

readonly Enter: "↵" = '↵';

Escape

readonly Escape: "Esc" = 'Esc';

Space

readonly Space: "␣" = '␣';

Tab

readonly Tab: "⇥" = '⇥';

Example

KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'
KEY_DISPLAY_SYMBOLS['Enter'] // '↵'
KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'
KEY_DISPLAY_SYMBOLS['Space'] // '␣'