@molecule/app-command-palette-cmdk

Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit src/index.ts JSDoc, not this file.

cmdk-style command palette provider for molecule.dev.

Implements CommandPaletteProvider from @molecule/app-command-palette as a HEADLESS in-memory state manager modeled on cmdk's API shape — it does NOT depend on or load the cmdk library; your app renders the overlay/input/list and binds the keyboard shortcut.

Quick Start

import { provider } from '@molecule/app-command-palette-cmdk'
import { setProvider } from '@molecule/app-command-palette'

setProvider(provider)

Type

provider

Installation

npm install @molecule/app-command-palette-cmdk @molecule/app-command-palette

API

Interfaces

CmdkConfig

Provider-specific configuration for the cmdk command palette provider.

interface CmdkConfig {
  /**
   * Whether the built-in matcher performs fuzzy (in-order subsequence)
   * matching in addition to exact substring matching. When `false`, only
   * exact case-insensitive substring matches are returned. A per-call
   * `options.filter` always takes precedence over the built-in matcher.
   * Defaults to `true` (fuzzy enabled).
   */
  defaultFuzzyMatch?: boolean

  /**
   * Default loop setting for keyboard navigation when no explicit
   * `loop` option is provided. Defaults to `true`.
   */
  defaultLoop?: boolean
}

CmdkPaletteInstance

Extended command palette instance with cmdk-specific internal methods used by framework bindings.

interface CmdkPaletteInstance {
  // -- Public API (from CommandPaletteInstance) --------------------------------
  open(): void
  close(): void
  toggle(): void
  isOpen(): boolean
  getQuery(): string
  setQuery(query: string): void
  getFilteredGroups(): CommandGroup[]
  pushPage(pageId: string): void
  popPage(): boolean
  getPageStack(): string[]
  getCurrentPage(): string
  setGroups(groups: CommandGroup[]): void
  addGroup(group: CommandGroup): void
  removeGroup(groupId: string): void
  addCommand(groupId: string, command: CommandItem): void
  removeCommand(commandId: string): void
  destroy(): void

  // -- Internal methods for framework bindings --------------------------------

  /** Returns the cmdk-specific config. */
  _getConfig(): CmdkConfig

  /** Returns whether keyboard navigation should loop. */
  _getLoop(): boolean

  /** Returns the placeholder for the current page. */
  _getPlaceholder(): string | undefined

  /**
   * Executes a command by id, handling page navigation returns.
   *
   * @param commandId - The id of the command to execute.
   */
  _executeCommand(commandId: string): void
}

Functions

createCmdkProvider(config)

Creates a cmdk-style command palette provider.

function createCmdkProvider(config?: CmdkConfig): CommandPaletteProvider

• config — Optional cmdk-specific configuration.

Returns: A CommandPaletteProvider backed by cmdk-style state management.

Constants

provider

Default cmdk command palette provider instance.

const provider: CommandPaletteProvider

Core Interface

Implements @molecule/app-command-palette interface.

Bond Wiring

Setup function to register this provider with the core interface:

import { setProvider } from '@molecule/app-command-palette'
import { provider } from '@molecule/app-command-palette-cmdk'

export function setupCommandPaletteCmdk(): void {
  setProvider(provider)
}

Injection Notes

Requirements

Peer dependencies:

• @molecule/app-command-palette >=1.0.1

Runtime Dependencies

• @molecule/app-command-palette

Filtering: a custom options.filter always takes precedence; otherwise the built-in matcher is used (exact substring scores highest, then, when defaultFuzzyMatch is true, an in-order subsequence match). Set the provider config defaultFuzzyMatch: false to restrict the built-in matcher to exact substring matches only. close() clears the query AND resets page navigation to root; pushPage(id) silently ignores unregistered page ids.

E2E Tests

Integration checklist — drive the real UI (live preview, no mocks), adapt each item to this app's actual screens/flows, and check every box off one by one. A box you can't check is an integration bug to fix — not a skip:

• [ ] The palette opens with the keyboard shortcut (Cmd+K / Ctrl+K) and via any visible trigger, and closes with Escape.
• [ ] Commands render in their groups, and typing fuzzy-filters them down to matches.
• [ ] Selecting a navigation command actually navigates (the URL/screen changes) — not just closes the palette.
• [ ] Executing an action command performs the real action with a visible effect.
• [ ] The whole flow works keyboard-only: arrow keys move the highlight, Enter executes the highlighted command.
• [ ] A query with no matches shows an empty state, not a stale or broken list.