caliper uidocs
DemoSign inGet Pro

Cancellation flow

Pro

A short flow that asks why, offers alternatives and confirms a cancellation.

Installs components/ui/cancellation-flow.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/cancellation-flow
Why are you leaving?

One answer helps us improve. It does not change what happens next.

When to use #

Use it for

  • Letting customers cancel without contacting support.
  • You want to offer a pause or a lower plan first.

Skip it when

  • You need to remove data immediately; confirm separately.

Installation #

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

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

The worked example comes with Pro

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

Checking your licence…

API reference #

CancellationFlow

component
PropTypeDefaultDescription
planName *string—
endsOn *string—When access ends, as text.
reasons *readonly CancelReason[]—
consequences *readonly string[]—What the customer loses or keeps.
onOffer((offerId: string, reason: string) => void)—
onCancel *(reason: string, details: string) => void | Promise<void>—
onUndo(() => void)—
classNamestring—

Accessibility #

It exposes status semantics, with 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.