Function formatForDisplay

packages/hotkeys/src/format.ts:92–132

(
  hotkey: RegisterableHotkey | (string & {}),
  options: FormatDisplayOptions = {},
)

 * ```
 */
export function formatForDisplay(
  hotkey: RegisterableHotkey | (string & {}),
  options: FormatDisplayOptions = {},
): string {
  const platform = options.platform ?? detectPlatform()
  const useSymbols = options.useSymbols ?? true
  const separatorToken =
    options.separatorToken ?? (platform === 'mac' && useSymbols ? ' ' : '+')
  const normalizedHotkey = normalizeRegisterableHotkey(
    hotkey as RegisterableHotkey,
    platform,
  )
  return normalizedHotkey
    .split('+')
    .map((segment) => {
      if (isModifierKey(segment)) {
        const modifierToken = (MODIFIER_ALIASES[segment] ??
          MODIFIER_ALIASES[segment.toLowerCase()]) as CanonicalModifier | 'Mod'
        return platform === 'mac'
          ? useSymbols
            ? MAC_MODIFIER_SYMBOLS[modifierToken]
            : MAC_MODIFIER_LABELS[modifierToken]
          : platform === 'windows'
            ? WINDOWS_MODIFIER_LABELS[modifierToken]
            : LINUX_MODIFIER_LABELS[modifierToken]
      } else {
        const keyDisplaySymbol =
          useSymbols &&
          KEY_DISPLAY_SYMBOLS[segment as keyof typeof KEY_DISPLAY_SYMBOLS]
        if (keyDisplaySymbol) return keyDisplaySymbol

        const punctuationKeyDisplayLabel =
          !useSymbols &&
          PUNCTUATION_KEY_DISPLAY_LABELS[
            segment as keyof typeof PUNCTUATION_KEY_DISPLAY_LABELS
          ]
        return punctuationKeyDisplayLabel || segment
      }
    })
    .join(separatorToken)
}

/**
 * @deprecated Use {@link formatForDisplay} instead with `useSymbols: false` option.