detectPlatform

function detectPlatform(userAgent?): HotkeyPlatform;

Defined in: platform.ts:32

Detects a platform from a user agent string, or from the browser's navigator when called without one.

Used internally to resolve platform-adaptive modifiers like 'Mod' (Command on Mac, Control elsewhere) and for platform-specific hotkey formatting. During server rendering, pass the request's User-Agent header to detect the user's platform instead of the server's.

Parameters#

userAgent?#

string | null

A user agent string, such as a request's User-Agent header. When omitted or null (a missing header), reads navigator.

Returns#

HotkeyPlatform

The detected platform: 'mac', 'windows', or 'linux'

Remarks#

Without a user agent, returns 'linux' on a server runtime (no navigator, or Node, Deno, Bun, or Cloudflare Workers), where navigator describes the server.

Example#

const platform = detectPlatform() // 'mac' | 'windows' | 'linux'
const modifier = resolveModifier('Mod', platform) // 'Meta' on Mac, 'Control' elsewhere

// On the server
detectPlatform(request.headers.get('user-agent'))