Settings command

When to use #

Use it for

A large settings area people cannot scan.

Skip it when

A short settings page.

Installation #

terminal

pnpm dlx shadcn@latest add @caliper/settings-command

Adds its 4 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source.

example.tsx

import { SettingsCommand } from "@/components/ui/settings-command"

The worked example comes with Pro

The 41-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

SettingsCommand

component

PropTypeDefault

open *boolean—

onOpenChange *(open: boolean) => void—

settings *readonly SettingCommand[]—

onToggle *(id: string, value: boolean) => void—

onChoose *(id: string, value: string) => void—

onNavigate *(id: string) => void—

It exposes combobox, listbox, option, presentation and status semantics, with aria-hidden, aria-expanded, aria-controls, aria-activedescendant, aria-label and aria-selected kept in step with state. Changes that matter are announced through a live region.

KeyBehaviour

↓Moves to the next item or value.

↑Moves to the previous item or value.

EnterActivates the focused control.

EscapeCloses or cancels, then returns focus to where it came from.

Motion #

It declares no animation in its component source. Any transition comes from its stylesheet, which uses the duration tokens that collapse to instant under prefers-reduced-motion.