caliper uidocs

Journey flow

Pro

Paths users take from one step to the next.

Installs components/ui/journey-flow.tsxDepends on d3-shapeMotion none in component source
pnpm dlx shadcn@latest add @caliper/journey-flow
Customer journey
Visited 48,200Left 42,100Signed up 6,100Left 2,800Started trial 3,300Left 2,280Paid 1,020Left 710Expanded 310

Customer journey
From toValue
Visited to Signed up6100
Visited to Left42100
Signed up to Started trial3300
Signed up to Left2800
Started trial to Paid1020
Started trial to Left2280
Paid to Expanded310
Paid to Left710
  • Visited to Signed up12.7%
  • Signed up to Started trial54.1%
  • Started trial to Paid30.9%
  • Paid to Expanded30.4%
  • Start to finish0.6%

When to use #

Use it for

  • Finding where people drift off.

Skip it when

  • The journey is linear.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/journey-flow

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 { JourneyFlow } from "@/components/ui/journey-flow"

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 #

JourneyFlow

component
PropTypeDefault
label *string—
stages *readonly JourneyStage[]—
classNamestring—

Accessibility #

It is built on native elements and keeps aria-label in step with state.

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.