Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key Hold API Reference
Held Keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Format for Display API Reference

resolveModifier

Function: resolveModifier()

ts
function resolveModifier(modifier, platform): CanonicalModifier;

Defined in: constants.ts:155

Resolves the platform-adaptive 'Mod' modifier to the appropriate canonical modifier.

The 'Mod' token represents the "primary modifier" on each platform:

  • macOS: 'Meta' (Command key ⌘)
  • Windows/Linux: 'Control' (Ctrl key)

This enables cross-platform hotkey definitions like 'Mod+S' that automatically map to Command+S on Mac and Ctrl+S on Windows/Linux.

Parameters

modifier

The modifier to resolve. If 'Mod', resolves based on platform.

"Mod" | CanonicalModifier

platform

The target platform. Defaults to auto-detection.

"mac" | "windows" | "linux"

Returns

CanonicalModifier

The canonical modifier name ('Control', 'Shift', 'Alt', or 'Meta')

Example

ts
resolveModifier('Mod', 'mac') // 'Meta'
resolveModifier('Mod', 'windows') // 'Control'
resolveModifier('Control', 'mac') // 'Control' (unchanged)