Skip to content
1.5k

Command

Command menu for search and quick actions.

import {
  Calculator,
  Calendar,

About

The <Command /> component uses the cmdk component by Dip.

Installation

pnpm dlx shadcn@latest add https://retroui.dev/r/base/command.json

Usage

import {
  Command,
  CommandDialog,
  CommandEmpty,
  CommandGroup,
  CommandInput,
  CommandItem,
  CommandList,
  CommandSeparator,
  CommandShortcut,
} from "@/components/ui/command"
<Command className="max-w-sm rounded-lg border">
  <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>

Composition

Use the following composition to build a Command:

Command
├── CommandInput
└── CommandList
    ├── CommandEmpty
    ├── CommandGroup
    │   ├── CommandItem
    │   └── CommandItem
    ├── CommandSeparator
    └── CommandGroup
        ├── CommandItem
        └── CommandItem

Examples

Basic

A simple command menu in a dialog.

Command Palette

Search for a command to run...

"use client"

import * as React from "react"

Shortcuts

Command Palette

Search for a command to run...

"use client"

import * as React from "react"

Groups

A command menu with groups, icons and separators.

Command Palette

Search for a command to run...

"use client"

import * as React from "react"

Scrollable

Scrollable command menu with multiple items.

Command Palette

Search for a command to run...

"use client"

import * as React from "react"

RTL

To enable RTL support in RetroUI, see the RTL configuration guide.

"use client"

import * as React from "react"

API Reference

See the cmdk documentation for more information.