Command - neobrutal-ui

Use Command for searchable actions or destinations. CommandDialog combines the list with a dialog, while Command can be embedded in a popover or panel. Shortcut annotations do not register keyboard handlers.

Loading preview...

"use client";

import { Calculator, Calendar, CreditCard, Settings, Smile, User } from "lucide-react";

import * as React from "react";

import { Button } from "@/components/ui/button";
import {
  CommandDialog,
  CommandEmpty,
  CommandGroup,
  CommandInput,
  CommandItem,
  CommandList,
  CommandSeparator,
  CommandShortcut,
} from "@/components/ui/command";

export default function CommandDemo() {
  const [open, setOpen] = React.useState(false);
  const [message, setMessage] = React.useState("");

  const runCommand = (label: string) => {
    setOpen(false);
    setMessage(`${label} selected.`);
  };

  React.useEffect(() => {
    const down = (event: KeyboardEvent) => {
      if (event.key === "j" && (event.metaKey || event.ctrlKey)) {
        event.preventDefault();
        setOpen((currentOpen) => !currentOpen);
      }
    };

    document.addEventListener("keydown", down);
    return () => document.removeEventListener("keydown", down);
  }, []);

  return (
    <div className="grid justify-items-start gap-3">
      <Button type="button" onClick={() => setOpen(true)}>
        Open command menu
      </Button>
      <p className="text-sm text-foreground">
        Or press{" "}
        <kbd className="pointer-events-none inline-flex h-5 items-center gap-1 rounded-base border-2 bg-main px-1.5 font-mono text-[10px] font-heading text-main-foreground select-none">
          <span>Ctrl/Command</span>
          <span>J</span>
        </kbd>
      </p>
      <CommandDialog open={open} onOpenChange={setOpen}>
        <CommandInput placeholder="Type a command or search..." />
        <CommandList>
          <CommandEmpty>No results found.</CommandEmpty>
          <CommandGroup heading="Suggestions">
            <CommandItem onSelect={() => runCommand("Calendar")}>
              <Calendar />
              <span>Calendar</span>
            </CommandItem>
            <CommandItem onSelect={() => runCommand("Emoji search")}>
              <Smile />
              <span>Search Emoji</span>
            </CommandItem>
            <CommandItem onSelect={() => runCommand("Calculator")}>
              <Calculator />
              <span>Calculator</span>
            </CommandItem>
          </CommandGroup>
          <CommandSeparator />
          <CommandGroup heading="Settings">
            <CommandItem onSelect={() => runCommand("Profile")}>
              <User />
              <span>Profile</span>
              <CommandShortcut>Ctrl+P</CommandShortcut>
            </CommandItem>
            <CommandItem onSelect={() => runCommand("Billing")}>
              <CreditCard />
              <span>Billing</span>
              <CommandShortcut>Ctrl+B</CommandShortcut>
            </CommandItem>
            <CommandItem onSelect={() => runCommand("Settings")}>
              <Settings />
              <span>Settings</span>
              <CommandShortcut>Ctrl+S</CommandShortcut>
            </CommandItem>
          </CommandGroup>
        </CommandList>
      </CommandDialog>
      <output className="block min-h-5 text-sm" aria-live="polite">
        {message}
      </output>
    </div>
  );
}

#Installation

Complete the base setup. For manual installation:

First time? Install the shared base once.

npx shadcn@latest add https://neobrutal-ui.andongmin.com/r/command.json

npm install cmdk@^1.1.1

Also install Dialog, then create components/ui/command.tsx:

"use client";

import * as React from "react";
import { Command as CommandPrimitive } from "cmdk";

import { cn } from "@/lib/utils";
import {
  Dialog,
  DialogContent,
  DialogDescription,
  DialogHeader,
  DialogTitle,
} from "@/components/ui/dialog";
import { SearchIcon } from "lucide-react";

function Command({ className, ...props }: React.ComponentProps<typeof CommandPrimitive>) {
  return (
    <CommandPrimitive
      data-slot="command"
      className={cn(
        "flex h-full w-full flex-col overflow-hidden rounded-[0px] border-2 border-border bg-main font-base text-main-foreground",
        className,
      )}
      {...props}
    />
  );
}

function CommandDialog({
  title = "Command Palette",
  description = "Search for a command to run...",
  children,
  className,
  showCloseButton = false,
  ...props
}: Omit<React.ComponentProps<typeof Dialog>, "children"> & {
  title?: string;
  description?: string;
  className?: string;
  showCloseButton?: boolean;
  children?: React.ReactNode;
}) {
  return (
    <Dialog {...props}>
      <DialogContent
        className={cn("overflow-hidden rounded-[0px]! border-0 p-0 shadow-shadow", className)}
        showCloseButton={showCloseButton}
      >
        <DialogHeader className="sr-only">
          <DialogTitle>{title}</DialogTitle>
          <DialogDescription>{description}</DialogDescription>
        </DialogHeader>
        <Command className="**:data-[slot=command-input-wrapper]:h-12 [&_[cmdk-group-heading]]:mb-1 [&_[cmdk-group-heading]]:px-2 [&_[cmdk-group-heading]]:font-heading [&_[cmdk-group]]:px-2 [&_[cmdk-input-wrapper]_svg]:size-5 [&_[cmdk-input]]:h-12 [&_[cmdk-item]]:px-2 [&_[cmdk-item]]:py-3 [&_[cmdk-item]_svg]:size-5">
          {children}
        </Command>
      </DialogContent>
    </Dialog>
  );
}

function CommandInput({
  className,
  "aria-label": ariaLabel,
  placeholder,
  ...props
}: React.ComponentProps<typeof CommandPrimitive.Input>) {
  return (
    <div
      data-slot="command-input-wrapper"
      className="flex h-9 items-center gap-2 border-b-2 border-border px-3"
    >
      <SearchIcon className="size-4 shrink-0" />
      <CommandPrimitive.Input
        data-slot="command-input"
        className={cn(
          "flex h-10 w-full rounded-base bg-transparent py-3 text-sm outline-hidden placeholder:text-main-foreground placeholder:opacity-50 disabled:cursor-not-allowed disabled:opacity-50",
          className,
        )}
        aria-label={ariaLabel ?? placeholder ?? "Command search"}
        placeholder={placeholder}
        {...props}
      />
    </div>
  );
}

function CommandList({ className, ...props }: React.ComponentProps<typeof CommandPrimitive.List>) {
  return (
    <CommandPrimitive.List
      data-slot="command-list"
      className={cn(
        "no-scrollbar max-h-[300px] scroll-py-1 overflow-x-hidden overflow-y-auto outline-none",
        className,
      )}
      {...props}
    />
  );
}

function CommandEmpty({
  className,
  ...props
}: React.ComponentProps<typeof CommandPrimitive.Empty>) {
  return (
    <CommandPrimitive.Empty
      data-slot="command-empty"
      className={cn("py-6 text-center text-sm", className)}
      {...props}
    />
  );
}

function CommandGroup({
  className,
  ...props
}: React.ComponentProps<typeof CommandPrimitive.Group>) {
  return (
    <CommandPrimitive.Group
      data-slot="command-group"
      className={cn(
        "overflow-hidden p-2 text-main-foreground **:[[cmdk-group-heading]]:px-2 **:[[cmdk-group-heading]]:py-1.5 **:[[cmdk-group-heading]]:text-base **:[[cmdk-group-heading]]:font-heading",
        className,
      )}
      {...props}
    />
  );
}

function CommandSeparator({
  className,
  ...props
}: React.ComponentProps<typeof CommandPrimitive.Separator>) {
  return (
    <CommandPrimitive.Separator
      data-slot="command-separator"
      className={cn("-mx-1 h-0.5 bg-border", className)}
      {...props}
    />
  );
}

function CommandItem({ className, ...props }: React.ComponentProps<typeof CommandPrimitive.Item>) {
  return (
    <CommandPrimitive.Item
      data-slot="command-item"
      className={cn(
        "relative flex cursor-default items-center gap-2 rounded-base px-2 py-1.5 text-sm text-main-foreground outline-0 outline-main-foreground select-none aria-selected:outline-2 data-[disabled=true]:pointer-events-none data-[disabled=true]:opacity-50 data-[selected=true]:outline-2 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
        className,
      )}
      {...props}
    />
  );
}

function CommandShortcut({ className, ...props }: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="command-shortcut"
      className={cn("ml-auto text-xs tracking-widest text-main-foreground", className)}
      {...props}
    />
  );
}

export {
  Command,
  CommandDialog,
  CommandInput,
  CommandList,
  CommandEmpty,
  CommandGroup,
  CommandItem,
  CommandShortcut,
  CommandSeparator,
};

#Usage

"use client";
import { useState } from "react";
import {
  Command,
  CommandInput,
  CommandList,
  CommandEmpty,
  CommandGroup,
  CommandItem,
} from "@/components/ui/command";

export default function WorkspaceCommands() {
  const [message, setMessage] = useState("No command selected.");
  return (
    <div className="grid gap-3">
      <Command className="max-w-sm rounded-base border-2 border-border">
        <CommandInput placeholder="Find an action…" aria-label="Find an action" />
        <CommandList>
          <CommandEmpty>No matching command.</CommandEmpty>
          <CommandGroup heading="Workspace">
            <CommandItem value="new-draft" onSelect={() => setMessage("Created a local draft.")}>
              New draft
            </CommandItem>
            <CommandItem disabled>Export workspace</CommandItem>
          </CommandGroup>
        </CommandList>
      </Command>
      <p role="status">{message}</p>
    </div>
  );
}

#API reference

Prop / part	Purpose	Default
`Command.shouldFilter`	Built-in client filtering	`true`
`CommandInput.value` / `onValueChange`	Controlled query	Uncontrolled
`CommandItem.value` / `keywords`	Search identity and extra terms	Derived label if omitted
`CommandItem.onSelect` / `disabled`	Action and availability	— / `false`
`CommandGroup.heading`	Related-action label	—
`CommandDialog.open` / `onOpenChange`	Dialog visibility	Uncontrolled
`CommandShortcut`	Visual annotation	No event handler
`CommandDialog.title`	Accessible dialog title	`Command Palette`
`CommandDialog.description`	Accessible dialog description	`Search for a command to run...`
`CommandDialog.showCloseButton`	Built-in dialog close control	`false`

#Accessibility

Label the search field and provide useful no-results feedback. Arrow keys navigate enabled items; Enter chooses an item. Keep action labels meaningful and register real keyboard shortcuts separately. For a command dialog, verify Escape and focus return. Use loading and failure feedback for remote searches rather than presenting an empty result as success.