caliper uidocs
DemoSign inGet Pro

Scan progress

Pro

A document being read: a scan line passes down the page and each field appears as the line reaches where it was found.

Installs components/ui/scan-progress.tsxDepends on lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/scan-progress

Reading… 0 of 6

Merchant
Not read yet
Date
Not read yet
Items
Not read yet
Total
Not read yet
VAT
Not read yet
Paid with
Not read yet

When to use #

Use it for

  • Receipt, invoice and ID capture.
  • Anywhere OCR fills a form.

Skip it when

  • Instant results; show the form.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/scan-progress

Adds its 2 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 { ScanProgress } from "@/components/ui/scan-progress"

The worked example comes with Pro

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

Checking your licence…

API reference #

ScanProgress

component
PropTypeDefaultDescription
document *ReactNode—The page being read, e.g. an image of a receipt.
fields *readonly ScanField[]—
progress *number—0 to 1.
labelstring"Reading the document"
classNamestring—

Accessibility #

It exposes progressbar and status semantics, with aria-label, aria-valuemin, aria-valuemax, aria-valuenow and 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.