Command
Fast, composable, unstyled command menu for React.
Made by pacocourseyLoading component...
Installation
When to use
Use this decision tree to determine when to use the Command component:
Usage
import {
Command,
CommandDialog,
CommandEmpty,
CommandGroup,
CommandInput,
CommandItem,
CommandList,
CommandSeparator,
CommandShortcut,
SimpleCommand,
} from "@/components/ui/command"<Command>
<CommandInput placeholder="Type a command or search..." />
<CommandList>
<CommandEmpty>No results found.</CommandEmpty>
<CommandGroup heading="Suggestions">
<CommandItem>Calendar</CommandItem>
<CommandItem>Search Emoji</CommandItem>
<CommandItem>Calculator</CommandItem>
</CommandGroup>
<CommandSeparator />
<CommandGroup heading="Settings">
<CommandItem>Profile</CommandItem>
<CommandItem>Billing</CommandItem>
<CommandItem>Settings</CommandItem>
</CommandGroup>
</CommandList>
</Command>Examples
Simple Command
A higher-level component that provides a simplified API for creating command menus.
Loading component...
SimpleCommand Props
| Prop | Type | Default | Description |
|---|---|---|---|
placeholder | string | "Type a command or search..." | Input placeholder text |
emptyMessage | string | "No results found." | Message shown when no results |
groups | Array<CommandGroup> | - | Array of command groups (required) |
size | 'sm' | 'default' | 'lg' | 'full' | 'default' | Command size variant |
className | string | - | Additional CSS classes |
CommandGroup Interface
interface CommandGroup {
heading?: string;
items: CommandItem[];
}
interface CommandItem {
icon?: React.ReactNode;
label: string;
shortcut?: string;
disabled?: boolean;
onSelect?: () => void;
}Usage
import { SimpleCommand } from "@/components/ui/command"
const commandGroups = [
{
heading: 'Actions',
items: [
{
icon: <Calendar />,
label: 'Calendar',
shortcut: '⌘C',
onSelect: () => console.log('Calendar selected'),
},
{
icon: <Settings />,
label: 'Settings',
disabled: true,
onSelect: () => console.log('Settings selected'),
},
],
},
];
<SimpleCommand
groups={commandGroups}
placeholder="Search commands..."
emptyMessage="No commands found."
/>Dialog
Loading component...
To show the command menu in a dialog, use the <CommandDialog /> component.
export function CommandMenu() {
const [open, setOpen] = React.useState(false)
React.useEffect(() => {
const down = (e: KeyboardEvent) => {
if (e.key === "k" && (e.metaKey || e.ctrlKey)) {
e.preventDefault()
setOpen((open) => !open)
}
}
document.addEventListener("keydown", down)
return () => document.removeEventListener("keydown", down)
}, [])
return (
<CommandDialog open={open} onOpenChange={setOpen}>
<CommandInput placeholder="Type a command or search..." />
<CommandList>
<CommandEmpty>No results found.</CommandEmpty>
<CommandGroup heading="Suggestions">
<CommandItem>Calendar</CommandItem>
<CommandItem>Search Emoji</CommandItem>
<CommandItem>Calculator</CommandItem>
</CommandGroup>
</CommandList>
</CommandDialog>
)
}Combobox
You can use the <Command /> component as a combobox. See the Combobox page for more information.
Props
Credits
Built by malinskibeniamin. The source code is available on GitHub.