Function: formatForDisplay()#

function formatForDisplay(hotkey, options): string;

Defined in: format.ts:92

Formats a hotkey for display in a user interface.

On macOS, uses symbols (⌘⇧S) in the same modifier order as normalizeHotkeyFromParsed. On Windows/Linux, uses text (Ctrl+Shift+S) with + separators. The separator can be customized with separatorToken.

Parameters#

hotkey#

The hotkey string or ParsedHotkey to format

string & object | RegisterableHotkey

options#

FormatDisplayOptions = {}

Formatting options

Returns#

string

A formatted string suitable for display

Example#

formatForDisplay('Mod+Shift+S', { platform: 'mac' })
// Returns: '⌘ ⇧ S' (symbols separated by spaces on macOS)

formatForDisplay('Mod+Shift+S', { platform: 'windows' })
// Returns: 'Ctrl+Shift+S'

formatForDisplay('Escape')
// Returns: 'Esc' (on all platforms)