KPI drilldown

When to use #

Use it for

Users ask why a number moved.

Skip it when

There are no segments to break down.

Installation #

terminal

pnpm dlx shadcn@latest add @caliper/kpi-drilldown

Adds its 5 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 { KpiDrilldown } from "@/components/ui/kpi-drilldown"

The worked example comes with Pro

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

Checking your licence…

API reference #

KpiDrilldown

component

PropTypeDefault

label *string—

value *number—

previous *number—

format((n: number) => string)(n) => n.toLocaleString("en-US")

goodWhen"up" | "down""up"

views *readonly DrillView[]—

classNamestring—

It exposes status and group semantics, with aria-label, aria-pressed and aria-hidden 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.