caliper uidocs

MRR waterfall

Pro

A waterfall of new, expansion, contraction and churn.

Installs components/ui/mrr-waterfall.tsxDepends on d3-shapeMotion none in component source
pnpm dlx shadcn@latest add @caliper/mrr-waterfall
MRR, September to October$318,400 to $341,300+$22,900 net
Sept$318,400New+$24,600Expansion+$11,800Contraction−$4,200Churn−$9,300Oct$341,300

MRR, September to October
StepAmountRunning total
Sept318400318400
New24600343000
Expansion11800354800
Contraction-4200350600
Churn-9300341300
Oct341300341300

When to use #

Use it for

  • Explaining why recurring revenue moved.

Skip it when

  • Revenue is one-off.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/mrr-waterfall

Adds its 3 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 { MrrWaterfall } from "@/components/ui/mrr-waterfall"

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 #

MrrWaterfall

component
PropTypeDefault
label *string—
start *number—
movements *readonly MrrMovement[]—
startLabelstring"Start"
endLabelstring"End"
loadingboolean—
errorstring—
classNamestring—

Accessibility #

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