caliper uidocs

Crm record

Pro

One person or company on a page: the relationship at a glance, one timeline you add calls and notes to, details you edit in place, their deals, the people around them and what is owed next.

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

Ostra Freight

ostra.example · Logistics · Lisbon

Health
ARR
None
Open pipeline
€48k
Renewal
None

Timeline

  1. Sent the SOC 2 report and the data processing terms.Email · Marta Silva · Maya Chen · 9 Oct, 08:45
  2. Marta wants intercompany in scope for Q1. Security review is the last blocker.Call · Marta Silva · Maya Chen · 8 Oct, 10:20
  3. Moved from Proposal to NegotiationDeal · Group close, 4 entities · Maya Chen · 7 Oct, 15:10
  4. Kick-off with João: budget approved, wants go-live before year end.Meeting · João Lima · Maya Chen · 2 Sept, 14:00
  5. Four entities, two currencies. NetSuite today; moving to Business Central next year.Note · Maya Chen · 21 Jul, 09:00

When to use #

Use it for

  • The detail page behind any person or account list.
  • Products where history matters as much as the current state.

Skip it when

  • A quick look from a list; open a drawer instead.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/crm-record

Adds its 13 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 { CrmRecord } from "@/components/ui/crm-record"

The worked example comes with Pro

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

Checking your licence…

API reference #

CrmRecord

component
PropTypeDefaultDescription
record *CrmRecordRef—
data *CrmData—
stages *readonly DealStage[]—
onDataChange *(data: CrmData) => void—
onOpenRecord *(kind: "person" | "company", id: string) => void—
onOpenDeal((id: string) => void)—Opens a deal, e.g. in the pipeline.
onBack{ label: string; onSelect: () => void; }—Shows a back link, e.g. to the contact list.
todaystringnew Date().toISOString().slice(0, 10)ISO date treated as today.
you *string—Your name, for what you log.
currencystring"EUR"
classNamestring—

Accessibility #

It exposes status semantics, with aria-hidden, aria-labelledby and aria-label kept in step with state. Changes that matter are announced through a live region.

Keyboard and focus handling comes from Radix popover: arrow keys move through items, Enter and Space select, and Escape closes and returns focus.

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.