Polecenie
Paleta poleceń obsługiwana za pomocą klawiatury do menu ⌘K, wyszukiwania globalnego i szybkich akcji — z neobrutalistycznymi ramkami i cieniami.
import {
Calculator,
Calendar,Command to komponowalna paleta poleceń: pole, które filtruje pogrupowaną listę akcji w miarę pisania, z nakładką CommandDialog dla scenariusza ⌘K. Zbudowany na cmdk i ostylowany zgodnie z neobrutalistyczną recepturą: grube obramowania, twarde cienie i wyrazista typografia.
Sięgnij po ten komponent, gdy:
- Palety ⌘K —
CommandDialogpod globalnym skrótem do nawigacji i akcji w całej aplikacji. - Wyszukiwanie w dokumentacji i aplikacji — filtrowanie stron, rekordów lub ustawień w miarę pisania, z podziałem na kategorie.
- Selektory z wieloma opcjami — przypisani, etykiety, emoji: wszędzie tam, gdzie zwykły select robi się nieporęczny.
O komponencie#
Komponent <Command /> korzysta z komponentu cmdk autorstwa Dip.
Instalacja#
pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/command.jsonnpx shadcn@latest add https://neobrutalism.com/r/base/command.jsonyarn dlx shadcn@latest add https://neobrutalism.com/r/base/command.jsonbunx --bun shadcn@latest add https://neobrutalism.com/r/base/command.json
Zainstaluj następujące zależności:
pnpm add cmdknpm install cmdkyarn add cmdkbun add cmdk
Skopiuj i wklej poniższy kod do swojego projektu.
"use client"
import * as React from "react"
import { Command as CommandPrimitive } from "cmdk"
import { CheckIcon, SearchIcon } from "lucide-react"
import { cn } from "@/lib/utils"
import {
Dialog,
DialogContent,
DialogDescription,
DialogHeader,
DialogTitle,
} from "@/components/ui/dialog"
import { InputGroup, InputGroupAddon } from "@/components/ui/input-group"
function Command({
className,
...props
}: React.ComponentProps<typeof CommandPrimitive>) {
return (
<CommandPrimitive
data-slot="command"
className={cn(
"flex size-full flex-col overflow-hidden rounded border-2 bg-popover p-1 text-popover-foreground",
className
)}
{...props}
/>
)
}
function CommandDialog({
title = "Command Palette",
description = "Search for a command to run...",
children,
className,
showCloseButton = false,
...props
}: React.ComponentProps<typeof Dialog> & {
title?: string
description?: string
className?: string
showCloseButton?: boolean
}) {
return (
<Dialog {...props}>
<DialogHeader className="sr-only">
<DialogTitle>{title}</DialogTitle>
<DialogDescription>{description}</DialogDescription>
</DialogHeader>
<DialogContent
className={cn(
"top-1/3 translate-y-0 overflow-hidden rounded p-0",
className
)}
showCloseButton={showCloseButton}
>
{children}
</DialogContent>
</Dialog>
)
}
function CommandInput({
className,
...props
}: React.ComponentProps<typeof CommandPrimitive.Input>) {
return (
<div data-slot="command-input-wrapper" className="p-1 pb-0">
<InputGroup className="h-8! rounded border-input/30 bg-input/30 shadow-none! *:data-[slot=input-group-addon]:pl-2!">
<CommandPrimitive.Input
data-slot="command-input"
className={cn(
"w-full text-sm outline-hidden disabled:cursor-not-allowed disabled:opacity-50",
className
)}
{...props}
/>
<InputGroupAddon>
<SearchIcon className="size-4 shrink-0 opacity-50" />
</InputGroupAddon>
</InputGroup>
</div>
)
}
function CommandList({
className,
...props
}: React.ComponentProps<typeof CommandPrimitive.List>) {
return (
<CommandPrimitive.List
data-slot="command-list"
className={cn(
"no-scrollbar max-h-72 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-1 text-foreground **:[[cmdk-group-heading]]:px-2 **:[[cmdk-group-heading]]:py-1.5 **:[[cmdk-group-heading]]:text-xs **:[[cmdk-group-heading]]:font-medium **:[[cmdk-group-heading]]:text-muted-foreground",
className
)}
{...props}
/>
)
}
function CommandSeparator({
className,
...props
}: React.ComponentProps<typeof CommandPrimitive.Separator>) {
return (
<CommandPrimitive.Separator
data-slot="command-separator"
className={cn("-mx-1 h-px bg-border", className)}
{...props}
/>
)
}
function CommandItem({
className,
children,
...props
}: React.ComponentProps<typeof CommandPrimitive.Item>) {
return (
<CommandPrimitive.Item
data-slot="command-item"
className={cn(
"group/command-item relative flex cursor-default items-center gap-2 rounded-sm px-2 py-1.5 text-sm outline-none select-none in-data-[slot=dialog-content]:rounded-sm! data-[disabled=true]:pointer-events-none data-[disabled=true]:opacity-50 data-selected:bg-accent data-selected:text-accent-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4 data-selected:*:[svg]:text-accent-foreground",
className
)}
{...props}
>
{children}
<CheckIcon className="ml-auto opacity-0 group-has-data-[slot=command-shortcut]/command-item:hidden group-data-[checked=true]/command-item:opacity-100" />
</CommandPrimitive.Item>
)
}
function CommandShortcut({
className,
...props
}: React.ComponentProps<"span">) {
return (
<span
data-slot="command-shortcut"
className={cn(
"ml-auto text-xs tracking-widest text-muted-foreground group-data-selected/command-item:text-accent-foreground",
className
)}
{...props}
/>
)
}
export {
Command,
CommandDialog,
CommandInput,
CommandList,
CommandEmpty,
CommandGroup,
CommandItem,
CommandShortcut,
CommandSeparator,
}
Zaktualizuj ścieżki importu, aby pasowały do konfiguracji twojego projektu.
Użycie#
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>Kompozycja#
Użyj następującej kompozycji, aby zbudować Command:
Command
├── CommandInput
└── CommandList
├── CommandEmpty
├── CommandGroup
│ ├── CommandItem
│ └── CommandItem
├── CommandSeparator
└── CommandGroup
├── CommandItem
└── CommandItemPrzykłady#
Podstawowy#
Proste menu poleceń w oknie dialogowym.
"use client"
import * as React from "react"Skróty#
"use client"
import * as React from "react"Grupy#
Menu poleceń z grupami, ikonami i separatorami.
"use client"
import * as React from "react"Przewijalne#
Przewijalne menu poleceń z wieloma elementami.
"use client"
import * as React from "react"RTL#
Aby włączyć obsługę RTL w Neobrutalism, zobacz przewodnik konfiguracji RTL.
"use client"
import * as React from "react"Dostępność#
Menu poleceń realizuje wzorzec WAI-ARIA Combobox: cmdk renderuje pole jako combobox powiązany z listą opcji listbox przez aria-controls i aria-activedescendant, więc fokus DOM zostaje w polu, a czytniki ekranu ogłaszają podświetloną pozycję. CommandDialog dokłada do tego semantykę dialogu modalnego.
Obsługa klawiatury:
| Klawisz | Działanie |
|---|---|
ArrowDown / ArrowUp | Przenosi zaznaczenie na następną / poprzednią pozycję |
Home / End | Przeskakuje do pierwszej / ostatniej pozycji |
Enter | Uruchamia zaznaczoną pozycję |
Escape | Zamyka menu (gdy renderowane w CommandDialog) |
Referencja API#
Więcej informacji znajdziesz w dokumentacji cmdk.