caliper uidocs

Checkout

Pro

A single-page checkout with contact, delivery, payment and an order summary.

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

When to use #

Use it for

  • Collecting everything needed to place an order.
  • Errors are explained next to the field.

Skip it when

  • You only need to take a payment; use a payment form.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/checkout

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.

example.tsx
import { Checkout } from "@/components/ui/checkout"

The worked example comes with Pro

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

Checking your licence…

API reference #

Checkout

component
PropTypeDefaultDescription
summary *ReactNode—The order summary shown beside the form.
subtotal *number—
delivery *readonly DeliveryOption[]—
currencystring"USD"
onPay *(values: CheckoutValues, total: number) => Promise<string | void>—Resolve with an error message to show, or nothing when paid.
classNamestring—

Accessibility #

It exposes alert and status semantics, with aria-invalid, aria-describedby, aria-label, aria-hidden and aria-live 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.