caliper uidocs

Whats new

Pro

Release notes people read: a few cards in a dialog, stepping with a slide in the direction of travel, dots for place, and Got it to close.

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

When to use #

Use it for

  • After a release with two to five changes worth knowing.
  • Announcing a redesigned screen.

Skip it when

  • Every release; keep it for changes that affect how people work.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/whats-new

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 { WhatsNew } from "@/components/ui/whats-new"

The worked example comes with Pro

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

Checking your licence…

API reference #

WhatsNew

component
PropTypeDefault
open *boolean—
onOpenChange *(open: boolean) => void—
items *readonly NewsItem[]—
version *string—

Accessibility #

It is built on native elements, so roles and focus come from the browser.

Keyboard and focus handling comes from Radix dialog: 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.