Overlays & Tooltips

Command

⌘K command palette (cmdk).

Import

tsx

import { Command } from "@cronus-ui/ui";

bash

npx cronus-ui add command

Examples

Command palette

A command palette with fuzzy search — open it with the button or ⌘K / Ctrl+K.

tsx

function CommandPalette() {
  const [open, setOpen] = useState(false);

  useEffect(() => {
    const handler = (event: KeyboardEvent) => {
      if (event.key === "k" && (event.metaKey || event.ctrlKey)) {
        event.preventDefault();
        setOpen((value) => !value);
      }
    };
    document.addEventListener("keydown", handler);
    return () => document.removeEventListener("keydown", handler);
  }, []);

  return (
    <>
      <Button variant="outline" onClick={() => setOpen(true)}>
        Open command palette
        <Badge variant="secondary" className="ml-1 font-mono text-[10px]">
          ⌘K
        </Badge>
      </Button>

      <CommandDialog
        open={open}
        onOpenChange={setOpen}
        title="Command palette"
        description="Search for a command to run."
      >
        <CommandInput placeholder="Type a command or search…" />
        <CommandList>
          <CommandEmpty>No results found.</CommandEmpty>
          <CommandGroup heading="Suggestions">
            <CommandItem onSelect={() => setOpen(false)}>
              <CalendarDays aria-hidden="true" />
              Calendar
            </CommandItem>
            <CommandItem onSelect={() => setOpen(false)}>
              <User aria-hidden="true" />
              Search profile
            </CommandItem>
            <CommandItem onSelect={() => setOpen(false)}>
              <Copy aria-hidden="true" />
              Copy link
            </CommandItem>
          </CommandGroup>
          <CommandSeparator />
          <CommandGroup heading="Settings">
            <CommandItem onSelect={() => setOpen(false)}>
              <Settings aria-hidden="true" />
              Settings
              <CommandShortcut>⌘S</CommandShortcut>
            </CommandItem>
            <CommandItem onSelect={() => setOpen(false)}>
              <Keyboard aria-hidden="true" />
              Keyboard shortcuts
              <CommandShortcut>⌘K</CommandShortcut>
            </CommandItem>
            <CommandItem onSelect={() => setOpen(false)}>
              <LifeBuoy aria-hidden="true" />
              Help &amp; support
            </CommandItem>
          </CommandGroup>
        </CommandList>
      </CommandDialog>
    </>
  );
}

.cronus

The same component declared in Cronus. Emitted at build time from the audit fixtures — the kernel renders it as HTML with no React.

PortedParity: MatchGeometry 1/1Pixel diff 0 pxLogic 1/1Parity scoreboard

default.cronus

app "audit-fixtures" {
  port 5176
}

style {
  preset aurora
  theme dark
}

component CommandDefault layout:inline style:command {
  label "Command menu"
  text "Type a command…"
  text "Calendar"
  text "Search"
}

page "/audit/command/default" type:custom {
  use CommandDefault
}

API Reference

Generated from the component's exported types.

CommandDialogProps

Extends ComponentProps<typeof Dialog>

Prop	Type	Default	Description
`title`	`string`	`"Command Menu"`	—
`description`	`string`	`"Search for a command to run..."`	—
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.

CommandProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive>

Prop	Type	Default	Description
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.

CommandInputProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive.Input>

Prop	Type	Default	Description
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.

CommandListProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive.List>

Prop	Type	Default	Description
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.

CommandEmptyProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive.Empty>

Prop	Type	Default	Description
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.

CommandGroupProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive.Group>

Prop	Type	Default	Description
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.

CommandItemProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive.Item>

Prop	Type	Default	Description
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.

CommandShortcutProps

Extends ComponentProps<"span">

Prop	Type	Default	Description
`className`	`string`	—	Additional class names merged onto the root.
`children`	`ReactNode`	—	Contents of the component.
`id`	`string`	—	DOM id of the root element.

CommandSeparatorProps

Extends ComponentPropsWithoutRef<typeof CommandPrimitive.Separator>

Prop	Type	Default	Description
`asChild`	`boolean`	—	Render as the child element via Slot.
`children`	`ReactNode`	—	Contents of the component.
`className`	`string`	—	Additional class names merged onto the root.
`value`	`string`	—	Controlled value.
`onValueChange`	`(value: string) => void`	—	Called when the value changes.
`loop`	`boolean`	—	—
`label`	`string`	—	Accessible name of the command list.