caliper uidocs
DemoSign inGet Pro

Metrics dashboard

Pro

A row of KPI tiles with change and a time range.

Installs components/ui/metrics-dashboard.tsxDepends on lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/metrics-dashboard
Compared with the previous 30 days

Showing the revenue drilldown below.

When to use #

Use it for

  • The top of an overview page.

Skip it when

  • Only one number matters; use a stat card.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/metrics-dashboard

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. It is built from MetricsDashboard, Delta and deltaTone.

example.tsx
import { MetricsDashboard, Delta, deltaTone } from "@/components/ui/metrics-dashboard"

The worked example comes with Pro

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

Checking your licence…

API reference #

MetricsDashboard

component
PropTypeDefault
metrics *readonly KpiMetric[]—
range *string—
rangesreadonly { value: string; label: string; }[][{ value: "7d", label: "7 days" }, { value: "30d", label: "30 days" }, { value: "90d", label: "90 days" }]
onRangeChange *(range: string) => void—
selectedstring | null—
onSelect((id: string) => void)—
loadingboolean—
errorstring—
classNamestring—

Delta

component
PropTypeDefault
value *number—
goodWhen"up" | "down""up"
comparestring"vs previous period"

deltaTone

component

No props of its own; it accepts the native props of its root element.

Accessibility #

It exposes alert semantics, with aria-hidden, aria-label, aria-busy and aria-pressed kept in step with state. Changes that matter are announced through a live region.

No custom key handling; Tab and the native activation keys do the work.

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.