formatForDisplay

Function: formatForDisplay()

function formatForDisplay(hotkey, options): string;

Defined in: format.ts:61

Formats a hotkey for display in a user interface.

On macOS, uses symbols (⌘⇧S). On Windows/Linux, uses text (Ctrl+Shift+S).

Parameters

hotkey

The hotkey string or ParsedHotkey to format

Hotkey | ParsedHotkey | string & object

options

FormatDisplayOptions = {}

Formatting options

Returns

string

A formatted string suitable for display

Example

formatForDisplay('Mod+Shift+S', { platform: 'mac' })
// Returns: '⇧⌘S'

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

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

Edit on GitHub

PreviousReactHotkeyRecorder

NextformatHotkey

Learn about TanStack Ads Hide Ads