caliper uidocs

Invoice editor

Pro

An editable invoice with line items and live totals.

Installs components/ui/invoice-editor.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/invoice-editor
Invoice lines
DescriptionQtyRateAmountRemove
$4,800
$3,600
Subtotal
$8,400
Tax
$672
Total due
$9,072

When to use #

Use it for

  • Creating or adjusting an invoice by hand.
  • Tax and discounts are calculated for the user.

Skip it when

  • The invoice is read-only; use the usage billing view.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/invoice-editor

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. It is built from InvoiceEditor and invoiceTotals.

example.tsx
import { InvoiceEditor, invoiceTotals } from "@/components/ui/invoice-editor"

The worked example comes with Pro

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

Checking your licence…

API reference #

InvoiceEditor

component
PropTypeDefault
value *InvoiceDraft—
onChange *(value: InvoiceDraft) => void—
currencystring"USD"
onSaveDraft *(value: InvoiceDraft) => void—
onSend *(value: InvoiceDraft) => void—
classNamestring—

invoiceTotals

component
PropTypeDefault
number *string—
customer *string—
email *string—
issued *string—
due *string—
lines *InvoiceLine[]—
taxRate *number—
discount *number—
notes *string—

Accessibility #

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