Command Palette

Preview

Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.

Install

Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.

npx shadcn@latest add https://ds.interlace.tools/r/command-palette.json

npx shadcn@latest add @interlace/command-palette

Import

16 named exports — pull the parts you need.

import { CommandPalette, CommandPaletteCollection, CommandPaletteContent, CommandPaletteDescription, CommandPaletteEmpty, CommandPaletteGroup, CommandPaletteGroupLabel, CommandPaletteInput, CommandPaletteItem, CommandPaletteList, CommandPaletteSeparator, CommandPaletteShortcut, CommandPaletteTitle, CommandPaletteTrigger, MIN_VIEWPORT, useCommandPaletteHotkey } from '@/components/ui/command-palette';

Anatomy

Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.

CommandPalette (Root)                    → Dialog.Root (open state)
    ├─ CommandPaletteTrigger               → Dialog.Trigger (optional)
    └─ CommandPaletteContent               → Dialog portal + backdrop +
        │                                    popup, wrapping an inline
        │                                    Combobox.Root
        ├─ CommandPaletteInput             (the search field — no border;
        │                                    the panel is the field's box)
        ├─ CommandPaletteEmpty
        └─ CommandPaletteList
            ├─ CommandPaletteGroup → CommandPaletteGroupLabel
            ├─ CommandPaletteItem → CommandPaletteShortcut
            └─ CommandPaletteSeparator

API reference

Parsed from the type declarations in the source — the same file the install writes into your tree, so this table can't drift from the component you get.

Accessibility

Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.

What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.

Focus + keyboard behaviour

Owned by @base-ui/react/combobox — focus trapping, dismissal and typeahead come from the headless primitive, not from us.

Focus ring (WCAG 2.2 SC 2.4.13)

Inherited from the preflight focus contract shipped in @interlace/theme.

Reduced motion

No animation to gate.

ARIA in the source

• role="combobox"
• role="dialog"
• role="status"
• aria-hidden

Examples

5 more states from the same story file.

R-rule compliance

Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.

Dependencies

Base UI primitive

@base-ui/react/combobox

Lucide icons

• SearchIcon

NPM dependencies

• @base-ui/react
• lucide-react

Registry dependencies

• @interlace/theme
• @interlace/cn
• @interlace/dialog

Source

The full implementation — components/ui/command-palette.tsx once installed.

'use client';

import * as React from 'react';

// @interlace/command-palette v1.0.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/command-palette
// What changed since: https://ds.interlace.tools/c/command-palette#history
// Generated banner — keep it, the upgrade diff reads this version.

/**
 * @interlace/ui — CommandPalette
 *
 * ⌘K. A modal surface holding one filterable list of actions.
 *
 * This is a COMPOSITION, not a new primitive: `Dialog` supplies the modal
 * (backdrop, focus trap, page inert, Escape, focus restore to the trigger),
 * and `@base-ui/react/combobox` in `inline` mode supplies the field and the
 * list (filtering, listbox ARIA, virtual focus, highlight). Neither half is
 * reimplemented here — this file is the ~200 lines of surface that sit
 * between them.

…474 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.