# Command

> ⌘K palette and filterable command lists.

Import from `@aspyn-io/kit`. Scaffold source: `npx shadcn@latest add https://design.aspyn.io/r/command.json`

## Install

```tsx
import {
  Command,
  CommandDialog,
  CommandInput,
  CommandList,
  CommandEmpty,
  CommandGroup,
  CommandItem,
  CommandShortcut,
  CommandSeparator,
} from "@aspyn-io/kit";
```

### ⌘K palette

Global search-and-act. Try the button or press ⌘K / Ctrl+K right now.

```tsx
const [open, setOpen] = React.useState(false);

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

<CommandDialog open={open} onOpenChange={setOpen}>
  <CommandInput placeholder="Search…" />
  <CommandList>
    <CommandEmpty>No results found.</CommandEmpty>
    <CommandGroup heading="Navigate">
      <CommandItem onSelect={goToDashboard}>Dashboard</CommandItem>
    </CommandGroup>
  </CommandList>
</CommandDialog>
```

### Inline command list

```tsx
<Command className="rounded-lg border shadow-sm">
  <CommandInput placeholder="Filter members…" />
  <CommandList>…</CommandList>
</Command>
```

### Groups with icons

A leading icon per item aids scanning. CommandItem lays out icon + label with a gap automatically.

```tsx
<Command className="rounded-lg border shadow-sm">
  <CommandInput placeholder="Type a command…" />
  <CommandList>
    <CommandEmpty>No results found.</CommandEmpty>
    <CommandGroup heading="Navigate">
      <CommandItem>
        <HomeIcon />
        Dashboard
      </CommandItem>
      <CommandItem>
        <UsersIcon />
        Customers
      </CommandItem>
    </CommandGroup>
    <CommandSeparator />
    <CommandGroup heading="Settings">
      <CommandItem>
        <SettingsIcon />
        Preferences
        <CommandShortcut>⌘,</CommandShortcut>
      </CommandItem>
    </CommandGroup>
  </CommandList>
</Command>
```

### Scrollable list

CommandList caps its height (max-h-[300px]) and scrolls, so long result sets stay contained.

```tsx
<Command className="rounded-lg border shadow-sm">
  <CommandInput placeholder="Search timezones…" />
  <CommandList>
    <CommandEmpty>No timezone found.</CommandEmpty>
    <CommandGroup heading="Timezones">
      {timezones.map((tz) => (
        <CommandItem key={tz}>{tz}</CommandItem>
      ))}
    </CommandGroup>
  </CommandList>
</Command>
```

## Notes

- Fuzzy filtering, keyboard navigation, and grouping come from cmdk.
- CommandDialog includes a visually-hidden title for screen readers: pass title to customize.