Command
Command palette and searchable list built on cmdk.
Saved preference for
elorm init --ui-library base-uiPreviewCode
"use client"
import * as React from "react"
import {
CalculatorIcon,
CalendarIcon,
CreditCardIcon,
SettingsIcon,
SmileIcon,
UserIcon,
} from "lucide-react"
import {
Command,
CommandDialog,
CommandEmpty,
CommandGroup,
CommandInput,
CommandItem,
CommandList,
CommandSeparator,
CommandShortcut,
CommandSurface,
} from "@/components/ui/command"
import { Button } from "@/components/ui/button"
export function CommandDemo() {
const [open, setOpen] = React.useState(false)
React.useEffect(() => {
const down = (event: KeyboardEvent) => {
if (event.key === "k" && (event.metaKey || event.ctrlKey)) {
event.preventDefault()
setOpen((value) => !value)
}
}
document.addEventListener("keydown", down)
return () => document.removeEventListener("keydown", down)
}, [])
return (
<>
<Button variant="outline" onClick={() => setOpen(true)}>
Open command palette
<CommandShortcut>⌘K</CommandShortcut>
</Button>
<CommandDialog open={open} onOpenChange={setOpen}>
<CommandInput placeholder="Type a command or search..." />
<CommandList>
<CommandEmpty>No results found.</CommandEmpty>
<CommandGroup heading="Suggestions">
<CommandItem>
<CalendarIcon />
<span>Calendar</span>
</CommandItem>
<CommandItem>
<SmileIcon />
<span>Search Emoji</span>
</CommandItem>
<CommandItem>
<CalculatorIcon />
<span>Calculator</span>
</CommandItem>
</CommandGroup>
<CommandSeparator />
<CommandGroup heading="Settings">
<CommandItem>
<UserIcon />
<span>Profile</span>
<CommandShortcut>⌘P</CommandShortcut>
</CommandItem>
<CommandItem>
<CreditCardIcon />
<span>Billing</span>
<CommandShortcut>⌘B</CommandShortcut>
</CommandItem>
<CommandItem>
<SettingsIcon />
<span>Settings</span>
<CommandShortcut>⌘S</CommandShortcut>
</CommandItem>
</CommandGroup>
</CommandList>
</CommandDialog>
</>
)
}
export function CommandInlineDemo() {
return (
<CommandSurface className="max-w-sm">
<Command>
<CommandInput placeholder="Search..." />
<CommandList>
<CommandEmpty>No results found.</CommandEmpty>
<CommandGroup heading="Actions">
<CommandItem>
<CalendarIcon />
<span>Schedule meeting</span>
</CommandItem>
<CommandItem>
<SettingsIcon />
<span>Open settings</span>
</CommandItem>
</CommandGroup>
</CommandList>
</Command>
</CommandSurface>
)
}
Installation#
Usage#
import { Command } from "@/components/ui/command"Command palette and searchable list built on cmdk.
Use CommandDialog for a palette overlay or Command + CommandSurface for inline search.
Composition#
Command
├── Dialog
├── CommandInput
├── CommandList
├── CommandItem