Platform

InstallationCopy Anchor Link

$ pnpm dlx shadcn@latest add @videorc/platform

It brings Accelerator with it.

UsageCopy Anchor Link

import {
  revealInFileManagerLabel,
  shortcutLabel,
  trashName,
} from "@/lib/platform";

shortcutLabel("CmdOrCtrl+K"); // "⌘K" on a Mac, "Ctrl+K" elsewhere
revealInFileManagerLabel(platform); // "Show in Finder", "Show in Explorer" or "Show in folder"
trashName(platform); // "Trash" or "Recycle Bin"

<DropdownMenuItem onClick={reveal}>
  {revealInFileManagerLabel(platform)}
</DropdownMenuItem>

Never type a platform word or a key glyph into copy. "Show in Finder" is wrong on Windows, and "⌘K" is wrong everywhere but macOS.

Where the platform comes fromCopy Anchor Link

currentPlatform() decides, in this order:

1. The platform you pass, with Node's process.platform names: "darwin", "win32", "linux". In Electron, your app knows it for certain; pass it when you have it.
2. data-platform on <html>, set by a small script before the first paint, so a Mac never flashes "Ctrl". See Using it in Electron.
3. The user agent: "Windows" reads as win32, "Macintosh" as darwin, and anything else as linux.

Not every function falls back the same way:

Pass the platform everywhere you can, and every label agrees.

BehaviorCopy Anchor Link

• Shortcuts read like the platform's menus: one keycap in system order on macOS (⇧⌘J, ⌘↵), words joined by "+" elsewhere (Ctrl+Shift+J, Ctrl+Enter). Accelerator does the printing.
• isCommandKey takes ⌘ alone on macOS and Ctrl alone elsewhere, never the Windows key. On a Mac, ⌃K and ⌃P stay text editing.
• displayKeyGlyph translates one Mac glyph for the platform: ⌘ to Ctrl, ⌥ to Alt, ⇧ to Shift. It's for a lone modifier; print whole shortcuts from accelerators.
• Linux is "other". appPlatform sorts every platform into "darwin", "win32" or "other", and the OS words use their generic form there: "Show in folder", "system settings".
• Server rendering. On a server there's no data-platform, and Node's own navigator reads as Linux, so a label rendered there says "Ctrl+K". If you render on a server, pass the platform, or render shortcut labels on the client only.

API referenceCopy Anchor Link

type AppPlatform = "darwin" | "win32" | "other";