caliper uidocs

Checkout screen

Pro

Checkout where every number in the total is explained before the button, and the button says the amount.

Installs components/ui/checkout-screen.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/checkout-screen

Upgrade to Team

Change seats or cancel any time.

14 people in your team today
Billing period

VAT applies unless you add a VAT number

When to use #

Use it for

  • Upgrades and seat purchases inside the product.
  • Tax depends on the buyer's country and VAT number.

Skip it when

  • Carts with many products; use the commerce set.
  • Collecting real card numbers yourself; use your payment provider's fields.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/checkout-screen

Adds its 11 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 { CheckoutScreen } from "@/components/ui/checkout-screen"

The worked example comes with Pro

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

Checking your licence…

API reference #

CheckoutScreen

component
PropTypeDefaultDescription
product *string—
pricePerSeat *number—Monthly price for one seat.
currencystring"USD"
seatsnumber1
maxSeatsnumber500
membersnumber—Shown beside seats, e.g. 14 people in the team today.
yearlyMonthsFreenumber2
taxRate *number—e.g. 0.23 for 23%. Removed when a VAT number checks out.
taxLabelstring"VAT"
checkVat((value: string) => Promise<VatCheck>)—Validate a VAT number; resolve with the company name or the reason.
merchant *string—Who charges the card, e.g. "Forma Studio Lda".
onPay *(total: number) => void | Promise<void>—
classNamestring—

Accessibility #

It is built on native elements and keeps aria-labelledby, aria-label and aria-live 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.