Command palette
A complete keyboard driven action surface with search, grouped results, and shortcuts.
npm install https://animui.stracture.net/__local/package.tgz- App-wide command search opened with Cmd or Ctrl plus K.
- Jumping to pages, creating items, and running actions from one input.
- Inline search panels that group results with shortcuts.
- Use combobox to pick a value inside a form.
- Use dropdown-menu for a short list of actions.
- Use expanding-search or search-field to search page content.
Installation
Install animui once, then import any component or block from its typed package entry.
React 19 and React DOM 19 are required. The package includes Free and Pro entries, styles and TypeScript declarations.
npm install https://animui.stracture.net/__local/package.tgzLoad the stylesheet once at your app root, then use the typed component import:
import 'animui/styles.css';
import { CommandPalette } from 'animui/command-palette';Read the Code tab for the implementation files and the API reference below for required props.
Download animui 0.3.0 · Agent guideUsage
Use it for product wide actions and navigation. Provide meaningful groups, icons, keyboard shortcuts, and handlers.
import { CommandPalette, type CommandItem } from "animui/command-palette"; const items: CommandItem[] = [ { id: "new", label: "New project", group: "Create", shortcut: "N" }, { id: "invite", label: "Invite teammate", group: "Team", keywords: ["member"] }, { id: "theme", label: "Toggle theme", description: "Switch light and dark" },]; export function Palette({ onClose }: { onClose: () => void }) { return <CommandPalette items={items} onSelect={item => run(item.id)} onClose={onClose} />;}Inside a dialog
<Dialog open={open} onOpenChange={setOpen}> <DialogContent title="Command palette"> <CommandPalette items={items} onSelect={item => { run(item.id); setOpen(false); }} onClose={() => setOpen(false)} /> </DialogContent></Dialog>API reference
2 parts. The first is the root.
CommandPalette
An inline search-and-run panel: a combobox input over grouped, filtered results with one highlight that follows the active row.
itemsRequiredCommandItem[]–Commands to search. Filtering matches label, description, group, and keywords.placeholderstring"Search commands"Input placeholder.onSelect(item: CommandItem) => void–Called on click or Enter. The query then clears and focus returns to the input.onClose() => void–Called on Escape with an empty query. Also renders an Esc close button.labelstring"Command palette"Visually hidden label for the input.CommandItem
Item type: { id: string; label: string; description?: string; group?: string; keywords?: string[]; icon?: ReactNode; shortcut?: string }. Items without a group land under Actions.
No props.
- Cmd/Ctrl+K
- Focuses the search input from anywhere on the page.
- ArrowDownorArrowUp
- Moves the active result.
- HomeorEnd
- Jumps to the first or last result.
- Enter
- Runs the active result.
- Escape
- Clears the query, or calls onClose when it is already empty.
- The input is a combobox with aria-controls and aria-activedescendant pointing at the listbox option, so focus never leaves the input.
- Results are role=option buttons with aria-selected, grouped in labelled role=group containers.
- It renders inline, not in a modal. Put it in a dialog yourself if it should trap focus and close on outside click.
- The panel rises in on a spring; the results frame springs to the list height as the query filters.
- Remaining rows glide into place when the shift is small and snap when it is a long jump; the highlight springs for pointer moves and slides in 70ms for arrow keys.
- Reduced motion removes the entrance, glides, and highlight travel.
- It fills its container width; below 480px shortcut hints are hidden and padding tightens.
- Below 340px the footer drops its last hint.
- Results scroll inside a 342px maximum height, and long labels ellipsize.
- Filtering is a simple substring match over label, description, group, and keywords on every keystroke.
- Rows are not virtualized and animate with layout; keep lists to a few hundred items or filter on the server.
Notes for AI
Give your coding assistant the Markdown reference instead of screenshots.
- Use for app-wide command search. For picking a value inside a form use combobox; for a small list of actions use dropdown-menu.
- Wrap it in dialog and pass onClose to close the dialog; map onSelect to your router or action handlers by item.id.
The full library index for assistants is at /llms.txt.