Skip to content

Installation

ABCrimson edited this page Mar 11, 2026 · 2 revisions

Installation

Requirements

  • Node.js >= 25.8.0 (ES2026 support)
  • pnpm >= 11.0.0 (recommended) or npm/yarn

Install Packages

Core + React (most common)

pnpm add modern-cmdk modern-cmdk/react

Core only (framework-agnostic)

pnpm add modern-cmdk

Optional: WASM Search

pnpm add modern-cmdk-search-wasm

Migration from cmdk

pnpm add -D modern-cmdk
npx modern-cmdk import-rewrite "src/**/*.tsx"
npx modern-cmdk data-attrs "src/**/*.tsx"
npx modern-cmdk forward-ref "src/**/*.tsx"
npx modern-cmdk should-filter "src/**/*.tsx"

Peer Dependencies

Package Peer Dependency
modern-cmdk/react react >= 19.0.0, react-dom >= 19.0.0
modern-cmdk-search-wasm None (standalone WASM)

TypeScript Configuration

Ensure your tsconfig.json targets ES2026:

{
  "compilerOptions": {
    "target": "ES2026",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "lib": ["ES2026", "DOM", "DOM.Iterable"]
  }
}

Bundle Size Budget

Package Gzipped
modern-cmdk ≤ 3 KB
modern-cmdk/react ≤ 5 KB
modern-cmdk-search-wasm (JS wrapper) ≤ 2 KB

Clone this wiki locally