caliper uidocs

Baseline chart

Pro

A value against a line you choose: area above and below take different colours, and you drag the line, or use the arrow keys, to ask what if the target were here.

Installs components/ui/baseline-chart.tsxDepends on d3-shapeMotion none in component source
pnpm dlx shadcn@latest add @caliper/baseline-chart
Weekly operating profit
$0k

Weekly operating profit
PeriodValueAgainst $0k
W12180521805
W22046820468
W31160011600
W4-2099-2099
W5-16313-16313
W6-26553-26553
W7-29657-29657
W8-24846-24846
W9-13961-13961
W10-820-820
W111010310103
W121521615216
W131303713037
W1447134713
W15-6375-6375
W16-15761-15761
W17-19423-19423
W18-15159-15159
W19-3357-3357
W201312413124
W212990429904
W224254942549
W234805648056
W244585145851

When to use #

Use it for

  • Profit and loss, latency against a budget, cash against a floor.
  • Testing a threshold before setting an alert.

Skip it when

  • Several series; use the line chart.
  • A fixed target nobody will move; draw a reference line.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/baseline-chart

Adds its 6 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 baselineSummary and BaselineChart.

example.tsx
import { baselineSummary, BaselineChart } from "@/components/ui/baseline-chart"

The worked example comes with Pro

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

Checking your licence…

API reference #

baselineSummary

component

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

BaselineChart

component
PropTypeDefaultDescription
label *string—
points *readonly BaselinePoint[]—
baselinenumber0
baselineLabelstring"Baseline"
unitstring""
formatValue((value: number) => string)numberText
stepnumber—Keyboard step for the baseline. Defaults to a fiftieth of the range.
higherIsBetterbooleantrue
heightnumber260
loadingboolean—
errorstring—
classNamestring—

Accessibility #

It exposes group, slider and status semantics, with aria-label, aria-busy, aria-hidden, aria-valuemin, aria-valuemax and aria-valuenow kept in step with state. Changes that matter are announced through a live region.

KeyBehaviour
↑Moves to the previous item or value.
↓Moves to the next item or value.
PageUpMoves by a larger step, or to the previous page.
PageDownMoves by a larger step, or to the next page.
HomeJumps to the first item or the minimum.
EndJumps to the last item or the maximum.

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.