modern-cmdk 1.2.1 → 1.2.3

package/dist/react/index.d.mts

@@ -1,7 +1,5 @@
 
 import { Component, ComponentPropsWithRef, Context, ErrorInfo, ReactNode } from "react";
-
-//#region src/react/activity.d.ts
 /** Activity mode — maps directly to React's Activity API */
 type ActivityMode = "visible" | "hidden";
 /** Props for the CommandActivity wrapper that controls visibility via React's Activity API. */
@@ -11,16 +9,11 @@ interface CommandActivityProps {
   readonly children: ReactNode;
 }
 /**
-* Wraps content in React 19.3.0-canary Activity API.
-* When mode="hidden", the component tree is preserved in memory but not rendered.
-* Falls back to conditional rendering if Activity is unavailable.
-*/
-declare function CommandActivity({
-  mode,
-  children
-}: CommandActivityProps): ReactNode;
-//#endregion
-//#region src/core/search/types.d.ts
+ * Wraps content in React's <Activity> API (React 19.2+).
+ * When mode="hidden", the component tree is preserved in memory but not rendered.
+ * Falls back to conditional rendering if Activity is unavailable.
+ */
+export declare function CommandActivity({ mode, children }: CommandActivityProps): ReactNode;
 /** Result of scoring a single item against a query */
 interface SearchResult {
   readonly id: ItemId;
@@ -41,34 +34,32 @@ interface SearchEngine extends Disposable {
   /** Dispose resources */
   [Symbol.dispose](): void;
 }
-//#endregion
-//#region src/core/types.d.ts
 /**
-* Branded type for command item IDs.
-* Prevents accidental mixing with plain strings at the type level.
-*
-* @example
-* ```ts
-* const id = itemId('copy');
-* // id has type ItemId, not string — catches type errors at compile time
-* ```
-*/
+ * Branded type for command item IDs.
+ * Prevents accidental mixing with plain strings at the type level.
+ *
+ * @example
+ * ```ts
+ * const id = itemId('copy');
+ * // id has type ItemId, not string — catches type errors at compile time
+ * ```
+ */
 declare const __itemIdBrand: unique symbol;
 type ItemId = string & {
   readonly [__itemIdBrand]: never;
 };
 /**
-* Branded type for group IDs.
-* Prevents accidental mixing with plain strings or ItemId at the type level.
-*/
+ * Branded type for group IDs.
+ * Prevents accidental mixing with plain strings or ItemId at the type level.
+ */
 declare const __groupIdBrand: unique symbol;
 type GroupId = string & {
   readonly [__groupIdBrand]: never;
 };
 /**
-* A registered command item in the palette.
-* All fields are readonly — state machine creates new items on update.
-*/
+ * A registered command item in the palette.
+ * All fields are readonly — state machine creates new items on update.
+ */
 interface CommandItem$1 {
   /** Unique identifier (branded type) */
   readonly id: ItemId;
@@ -88,9 +79,9 @@ interface CommandItem$1 {
   readonly data?: Readonly<Record<string, unknown>> | undefined;
 }
 /**
-* A command group for categorizing items.
-* Groups are rendered with headings and sorted by priority.
-*/
+ * A command group for categorizing items.
+ * Groups are rendered with headings and sorted by priority.
+ */
 interface CommandGroup$1 {
   /** Unique identifier (branded type) */
   readonly id: GroupId;
@@ -100,10 +91,10 @@ interface CommandGroup$1 {
   readonly priority?: number | undefined;
 }
 /**
-* Immutable state snapshot of the command palette.
-* Consumed by React via `useSyncExternalStore` — each mutation
-* produces a new object reference for efficient re-render detection.
-*/
+ * Immutable state snapshot of the command palette.
+ * Consumed by React via `useSyncExternalStore` — each mutation
+ * produces a new object reference for efficient re-render detection.
+ */
 interface CommandState {
   /** Current search query string */
   readonly search: string;
@@ -225,12 +216,10 @@ interface CommandMachineOptions {
   /** Item count threshold for automatic virtualization (default: 100) */
   readonly virtualizeThreshold?: number | undefined;
 }
-//#endregion
-//#region src/core/keyboard/parser.d.ts
 /**
-* Structured representation of a keyboard shortcut after parsing.
-* The `normalized` field provides a deterministic string for dedup and comparison.
-*/
+ * Structured representation of a keyboard shortcut after parsing.
+ * The `normalized` field provides a deterministic string for dedup and comparison.
+ */
 interface ParsedShortcut {
   readonly key: string;
   readonly meta: boolean;
@@ -240,18 +229,16 @@ interface ParsedShortcut {
   readonly raw: string;
   readonly normalized: string;
 }
-//#endregion
-//#region src/core/keyboard/index.d.ts
 interface ShortcutBinding {
   readonly shortcut: ParsedShortcut;
   readonly itemId: ItemId;
   readonly handler: () => void;
 }
 /**
-* Manages keyboard shortcut bindings with global keydown listening.
-* Supports `using` for automatic cleanup of both individual bindings and the
-* global document listener. Detects conflicts via Map.groupBy (ES2026).
-*/
+ * Manages keyboard shortcut bindings with global keydown listening.
+ * Supports `using` for automatic cleanup of both individual bindings and the
+ * global document listener. Detects conflicts via Map.groupBy (ES2026).
+ */
 declare class KeyboardShortcutRegistry implements Disposable {
   #private;
   constructor(options?: {
@@ -271,13 +258,11 @@ declare class KeyboardShortcutRegistry implements Disposable {
   getBindings(): ReadonlyMap<string, ShortcutBinding>;
   [Symbol.dispose](): void;
 }
-//#endregion
-//#region src/core/registry.d.ts
 /**
-* Manages registration and lookup of command items and groups.
-* Uses set operation helpers (union/intersection/difference) for efficient ID operations.
-* All registration methods return Disposable for automatic cleanup via `using`.
-*/
+ * Manages registration and lookup of command items and groups.
+ * Uses set operation helpers (union/intersection/difference) for efficient ID operations.
+ * All registration methods return Disposable for automatic cleanup via `using`.
+ */
 declare class CommandRegistry implements Disposable {
   #private;
   /** Register an item — returns Disposable for `using` auto-deregister */
@@ -326,8 +311,6 @@ declare class CommandRegistry implements Disposable {
   clear(): void;
   [Symbol.dispose](): void;
 }
-//#endregion
-//#region src/core/machine.d.ts
 /** Command machine — explicit resource management via `using` */
 interface CommandMachine extends Disposable {
   getState(): CommandState;
@@ -344,8 +327,6 @@ interface CommandMachine extends Disposable {
   getFilteredIdIndex(): ReadonlyMap<ItemId, number>;
   [Symbol.dispose](): void;
 }
-//#endregion
-//#region src/react/async-items.d.ts
 interface CommandAsyncItemsProps {
   /** Promise that resolves to items */
   readonly items: Promise<readonly CommandItem$1[]>;
@@ -355,22 +336,10 @@ interface CommandAsyncItemsProps {
   readonly children: (items: readonly CommandItem$1[]) => ReactNode;
 }
 /** Suspense-based async item loader that resolves a promise of items using React 19 `use()`. */
-declare function CommandAsyncItems({
-  items,
-  fallback,
-  children
-}: CommandAsyncItemsProps): ReactNode;
-//#endregion
-//#region src/react/badge.d.ts
+export declare function CommandAsyncItems({ items, fallback, children }: CommandAsyncItemsProps): ReactNode;
 interface CommandBadgeProps extends ComponentPropsWithRef<"span"> {}
 /** Inline badge for categorization or status indicators on command items. */
-declare function CommandBadge({
-  ref,
-  children,
-  ...props
-}: CommandBadgeProps): ReactNode;
-//#endregion
-//#region src/react/dialog.d.ts
+export declare function CommandBadge({ ref, children, ...props }: CommandBadgeProps): ReactNode;
 interface CommandDialogProps extends CommandMachineOptions {
   readonly children?: ReactNode;
   readonly className?: string;
@@ -385,29 +354,10 @@ interface CommandDialogProps extends CommandMachineOptions {
   readonly container?: HTMLElement | null;
 }
 /** Dialog variant that wraps the command palette in a Radix UI Dialog with focus trap and overlay. */
-declare function CommandDialog({
-  children,
-  className,
-  overlayClassName,
-  contentClassName,
-  label,
-  description,
-  open: controlledOpen,
-  onOpenChange,
-  container,
-  ...machineOptions
-}: CommandDialogProps): ReactNode;
-//#endregion
-//#region src/react/empty.d.ts
+export declare function CommandDialog({ children, className, overlayClassName, contentClassName, label, description, open: controlledOpen, onOpenChange, container, ...machineOptions }: CommandDialogProps): ReactNode;
 interface CommandEmptyProps extends ComponentPropsWithRef<"div"> {}
 /** Rendered when no items match the current search query. */
-declare function CommandEmpty({
-  ref,
-  children,
-  ...props
-}: CommandEmptyProps): ReactNode;
-//#endregion
-//#region src/react/group.d.ts
+export declare function CommandEmpty({ ref, children, ...props }: CommandEmptyProps): ReactNode;
 interface CommandGroupProps extends ComponentPropsWithRef<"div"> {
   /** Heading text displayed above the group */
   readonly heading?: string;
@@ -417,16 +367,7 @@ interface CommandGroupProps extends ComponentPropsWithRef<"div"> {
   readonly forceId?: string;
 }
 /** Visual grouping container with an optional heading that hides when no items match. */
-declare function CommandGroup({
-  ref,
-  children,
-  heading,
-  priority,
-  forceId,
-  ...props
-}: CommandGroupProps): ReactNode;
-//#endregion
-//#region src/react/highlight.d.ts
+export declare function CommandGroup({ ref, children, heading, priority, forceId, ...props }: CommandGroupProps): ReactNode;
 interface CommandHighlightProps {
   /** The full text to display */
   readonly text: string;
@@ -436,25 +377,12 @@ interface CommandHighlightProps {
   readonly highlightClassName?: string;
 }
 /** Renders search match highlighting by splitting text at scored match ranges. */
-declare function CommandHighlight({
-  text,
-  ranges,
-  highlightClassName
-}: CommandHighlightProps): ReactNode;
-//#endregion
-//#region src/react/input.d.ts
+export declare function CommandHighlight({ text, ranges, highlightClassName }: CommandHighlightProps): ReactNode;
 interface CommandInputProps extends Omit<ComponentPropsWithRef<"input">, "value" | "onChange" | "type" | "role"> {
   readonly onValueChange?: (value: string) => void;
 }
 /** Combobox input that drives the command palette search state. */
-declare function CommandInput({
-  ref,
-  placeholder,
-  onValueChange,
-  ...props
-}: CommandInputProps): ReactNode;
-//#endregion
-//#region src/react/item.d.ts
+export declare function CommandInput({ ref, placeholder, onValueChange, ...props }: CommandInputProps): ReactNode;
 interface CommandItemProps extends Omit<ComponentPropsWithRef<"div">, "onSelect" | "value"> {
   readonly value: string;
   readonly keywords?: readonly string[];
@@ -464,19 +392,7 @@ interface CommandItemProps extends Omit<ComponentPropsWithRef<"div">, "onSelect"
   readonly forceId?: string;
 }
 /** Individual selectable item in the command list with keyboard and pointer activation. */
-declare function CommandItem({
-  ref,
-  children,
-  value,
-  keywords,
-  onSelect,
-  disabled,
-  shortcut,
-  forceId,
-  ...props
-}: CommandItemProps): ReactNode;
-//#endregion
-//#region src/react/list.d.ts
+export declare function CommandItem({ ref, children, value, keywords, onSelect, disabled, shortcut, forceId, ...props }: CommandItemProps): ReactNode;
 interface CommandListProps extends ComponentPropsWithRef<"div"> {
   /** Override automatic virtualization (default: auto at >100 items, false to opt-out) */
   readonly virtualize?: boolean;
@@ -488,31 +404,13 @@ interface CommandListProps extends ComponentPropsWithRef<"div"> {
   readonly announceResults?: (count: number) => string;
 }
 /** Scrollable list container with auto-virtualization and aria-live announcements. */
-declare function CommandList({
-  ref,
-  children,
-  virtualize,
-  estimateSize,
-  overscan,
-  announceResults,
-  style,
-  ...props
-}: CommandListProps): ReactNode;
-//#endregion
-//#region src/react/loading.d.ts
+export declare function CommandList({ ref, children, virtualize, estimateSize, overscan, announceResults, style, ...props }: CommandListProps): ReactNode;
 interface CommandLoadingProps extends ComponentPropsWithRef<"div"> {
   /** Override the loading state detection */
   readonly loading?: boolean;
 }
 /** Shown during async operations, with configurable loading state override. */
-declare function CommandLoading({
-  ref,
-  children,
-  loading: loadingOverride,
-  ...props
-}: CommandLoadingProps): ReactNode;
-//#endregion
-//#region src/react/page.d.ts
+export declare function CommandLoading({ ref, children, loading: loadingOverride, ...props }: CommandLoadingProps): ReactNode;
 /** Branded page identifier */
 type CommandPageId = string & {
   readonly __brand: "CommandPageId";
@@ -523,47 +421,25 @@ interface CommandPageProps {
   readonly children?: ReactNode;
 }
 /** Page navigation container that only renders when its ID matches the active page. */
-declare function CommandPage({
-  id,
-  children
-}: CommandPageProps): ReactNode;
-//#endregion
-//#region src/react/separator.d.ts
+export declare function CommandPage({ id, children }: CommandPageProps): ReactNode;
 interface CommandSeparatorProps extends ComponentPropsWithRef<"div"> {}
 /** Visual divider between items or groups, rendered as a presentational element. */
-declare function CommandSeparator({
-  ref,
-  ...props
-}: CommandSeparatorProps): ReactNode;
-//#endregion
-//#region src/react/shortcut.d.ts
+export declare function CommandSeparator({ ref, ...props }: CommandSeparatorProps): ReactNode;
 interface CommandShortcutProps extends ComponentPropsWithRef<"kbd"> {
   /** Shortcut string to display (e.g., "Mod+K"). If not provided, reads from nearest Command.Item. */
   readonly shortcut?: string;
 }
 /** Keyboard shortcut display with platform-aware formatting (e.g., Cmd vs Ctrl). */
-declare function CommandShortcut({
-  ref,
-  shortcut,
-  children,
-  ...props
-}: CommandShortcutProps): ReactNode;
-//#endregion
-//#region src/react/command.d.ts
+export declare function CommandShortcut({ ref, shortcut, children, ...props }: CommandShortcutProps): ReactNode;
 interface CommandRootProps extends CommandMachineOptions {
   readonly children?: ReactNode;
   readonly className?: string;
   readonly label?: string;
 }
 /** Root compound component that provides the command state machine context to all children. */
-declare function CommandRoot({
-  children,
-  className,
-  label,
-  ...machineOptions
-}: CommandRootProps): ReactNode;
+declare function CommandRoot({ children, className, label, ...machineOptions }: CommandRootProps): ReactNode;
 /** Compound component namespace */
-declare const Command: typeof CommandRoot & {
+export declare const Command: typeof CommandRoot & {
   readonly Input: typeof CommandInput;
   readonly List: typeof CommandList;
   readonly Item: typeof CommandItem;
@@ -579,8 +455,6 @@ declare const Command: typeof CommandRoot & {
   readonly AsyncItems: typeof CommandAsyncItems;
   readonly Activity: typeof CommandActivity;
 };
-//#endregion
-//#region src/react/context.d.ts
 /** Branded newtype for the root instance ID */
 type CommandRootId = string & {
   readonly __brand: "CommandRootId";
@@ -623,14 +497,12 @@ interface CommandStateContextValue {
   /** Map of visible item IDs to their translateY pixel offsets. null = not virtualizing. */
   readonly virtualPositionMap: ReadonlyMap<ItemId, number> | null;
 }
-declare const CommandStableContext: Context<CommandStableContextValue | null>;
-declare const CommandStateContext: Context<CommandStateContextValue | null>;
+export declare const CommandStableContext: Context<CommandStableContextValue | null>;
+export declare const CommandStateContext: Context<CommandStateContextValue | null>;
 interface CommandGroupContextValue {
   readonly groupId: string;
   readonly headingId: string;
 }
-//#endregion
-//#region src/react/error-boundary.d.ts
 interface CommandErrorBoundaryProps {
   readonly children: ReactNode;
   readonly fallback?: ReactNode | ((error: Error) => ReactNode);
@@ -640,14 +512,12 @@ interface CommandErrorBoundaryState {
   readonly error: Error | null;
 }
 /** Error boundary for graceful failure recovery in command subtrees. */
-declare class CommandErrorBoundary extends Component<CommandErrorBoundaryProps, CommandErrorBoundaryState> {
+export declare class CommandErrorBoundary extends Component<CommandErrorBoundaryProps, CommandErrorBoundaryState> {
   override state: CommandErrorBoundaryState;
   static getDerivedStateFromError(error: Error): CommandErrorBoundaryState;
   override componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
   override render(): ReactNode;
 }
-//#endregion
-//#region src/react/hooks/use-command.d.ts
 interface UseCommandReturn {
   readonly state: CommandState;
   readonly isPending: boolean;
@@ -658,34 +528,28 @@ interface UseCommandReturn {
   readonly id: CommandRootId;
 }
 /** Core hook that binds a CommandMachine to React via useSyncExternalStore, useTransition, and useOptimistic. */
-declare function useCommand(machine: CommandMachine): UseCommandReturn;
-//#endregion
-//#region src/react/hooks/use-command-state.d.ts
+export declare function useCommand(machine: CommandMachine): UseCommandReturn;
 /** Get the full command state with proper subscription */
-declare function useCommandState(): CommandState;
+export declare function useCommandState(): CommandState;
 /** Get a selected slice of command state — only re-renders when selected value changes */
-declare function useCommandState<T>(selector: (state: CommandState) => T): T;
-//#endregion
-//#region src/react/hooks/use-devtools.d.ts
+export declare function useCommandState<T>(selector: (state: CommandState) => T): T;
 /**
-* Exposes command palette internals to browser devtools.
-* Only active in development — completely tree-shaken in production builds.
-*
-* @example
-* ```tsx
-* function MyPalette() {
-*   useCommandDevtools('main');
-*   return <Command>...</Command>;
-* }
-* ```
-*/
-declare function useCommandDevtools(label?: string): void;
-//#endregion
-//#region src/react/hooks/use-keyboard.d.ts
+ * Exposes command palette internals to browser devtools.
+ * Development only: the effect is gated on `process.env.NODE_ENV` and returns early in
+ * production builds (the hook itself still ships). Call it from a component rendered inside
+ * `<Command>`: outside one there is no machine to inspect and the hook does nothing.
+ *
+ * @example
+ * ```tsx
+ * function DevtoolsBridge() {
+ *   useCommandDevtools('main');
+ *   return null;
+ * }
+ * ```
+ */
+export declare function useCommandDevtools(label?: string): void;
 /** Create a keydown handler for command palette keyboard navigation */
-declare function createKeydownHandler(machine: CommandMachine, getState: () => CommandState): (event: KeyboardEvent) => void;
-//#endregion
-//#region src/react/hooks/use-register.d.ts
+export declare function createKeydownHandler(machine: CommandMachine, getState: () => CommandState): (event: KeyboardEvent) => void;
 /** Options for item registration */
 interface RegisterItemOptions {
   readonly keywords?: readonly string[];
@@ -697,16 +561,14 @@ interface RegisterItemOptions {
   readonly forceId?: string;
 }
 /** Register a command item with the machine — auto-deregisters on unmount */
-declare function useRegisterItem(value: string, options?: RegisterItemOptions): ItemId;
+export declare function useRegisterItem(value: string, options?: RegisterItemOptions): ItemId;
 /** Options for group registration */
 interface RegisterGroupOptions {
   readonly priority?: number;
   readonly forceId?: string;
 }
 /** Register a command group with the machine — auto-deregisters on unmount */
-declare function useRegisterGroup(heading?: string, options?: RegisterGroupOptions): GroupId;
-//#endregion
-//#region src/react/hooks/use-virtualizer.d.ts
+export declare function useRegisterGroup(heading?: string, options?: RegisterGroupOptions): GroupId;
 interface VirtualizerOptions {
   readonly count: number;
   readonly estimateSize: number;
@@ -727,6 +589,5 @@ interface VirtualizerReturn {
   readonly measureElement: (element: HTMLElement | null) => void;
 }
 /** Lightweight virtualizer for large item lists using ResizeObserver and scroll tracking. */
-declare function useVirtualizer(options: VirtualizerOptions): VirtualizerReturn;
-//#endregion
-export { type ActivityMode, Command, CommandActivity, type CommandActivityProps, CommandAsyncItems, type CommandAsyncItemsProps, CommandBadge, type CommandBadgeProps, type CommandContextValue, CommandDialog, type CommandDialogProps, CommandEmpty, type CommandEmptyProps, CommandErrorBoundary, type CommandErrorBoundaryProps, CommandGroup, type CommandGroupContextValue, type CommandGroupProps, CommandHighlight, type CommandHighlightProps, CommandInput, type CommandInputProps, CommandItem, type CommandItemProps, CommandList, type CommandListProps, CommandLoading, type CommandLoadingProps, CommandPage, type CommandPageId, type CommandPageProps, type CommandRootId, type CommandRootProps, CommandSeparator, type CommandSeparatorProps, CommandShortcut, type CommandShortcutProps, CommandStableContext, type CommandStableContextValue, CommandStateContext, type CommandStateContextValue, type RegisterGroupOptions, type RegisterItemOptions, type UseCommandReturn, type VirtualItem, type VirtualizerOptions, type VirtualizerReturn, createKeydownHandler, useCommand, useCommandDevtools, useCommandState, useRegisterGroup, useRegisterItem, useVirtualizer };
+export declare function useVirtualizer(options: VirtualizerOptions): VirtualizerReturn;
+export type { ActivityMode, CommandActivityProps, CommandAsyncItemsProps, CommandBadgeProps, CommandContextValue, CommandDialogProps, CommandEmptyProps, CommandErrorBoundaryProps, CommandGroupContextValue, CommandGroupProps, CommandHighlightProps, CommandInputProps, CommandItemProps, CommandListProps, CommandLoadingProps, CommandPageId, CommandPageProps, CommandRootId, CommandRootProps, CommandSeparatorProps, CommandShortcutProps, CommandStableContextValue, CommandStateContextValue, RegisterGroupOptions, RegisterItemOptions, UseCommandReturn, VirtualItem, VirtualizerOptions, VirtualizerReturn };