CommandPalette

A modal command search, the classic Ctrl+K palette.

CommandPalette rendered by Tarve CommandPalette rendered by Tarve
Native render. The live version loads when this comes into view.

Import

import { CommandPalette } from "@tarve/core";

Usage

CommandPalette.tsx
import { Button, CommandPalette } from "@tarve/core";

let open = true;
let query = "";

<>
  <Button variant="outline" onClick={() => (open = true)}>
    Open command palette
  </Button>
  <CommandPalette
    id="palette"
    open={open}
    query={query}
    placeholder="Type a command…"
    items={[
      { value: "new", label: "New file", keywords: ["create"] },
      { value: "theme", label: "Toggle theme" },
      { value: "quit", label: "Quit" },
    ]}
    onOpenChange={(next) => {
      open = next;
    }}
    onQueryChange={(next) => {
      query = next;
    }}
    onSelect={(value) => console.log(value)}
  />
</>

Props

PropTypeDefault
open required boolean—
closeOnOverlay booleantrue
closeOnSelect booleantrue
onOpenChange (open: boolean) => void—
onSelect (value: string) => void—
width number520
Inherited from CommandProps 9 props
PropTypeDefault
id required string—
items required readonly CommandItem[]—
query required string—
emptyText string—
onEscape () => void—
onQueryChange (query: string) => void—
onValueChange (value: string) => void—
placeholder string—
value string—

Common props

Shared by every component. See descriptions →

childrenclassclassNamehighlightkeymotionFromonHighlightonPasteonPointerLeaveonPointerMoveonSizeonTransitionEndrovingGroup

Types

CommandItem
interface CommandItem {
  value: string;
  label: string;
  keywords?: readonly string[];
  icon?: IconName;
  group?: string;
  shortcut?: string;
  disabled?: boolean;
}