caliper uidocs

Illustrations

Pro

A set of spot illustrations for empty and onboarding states.

Installs components/ui/illustrations.tsxDepends on none beyond ReactMotion none in component source
pnpm dlx shadcn@latest add @caliper/illustrations
  • inbox
  • search
  • folder
  • chart
  • shield
  • rocket
  • calendar
  • broken

When to use #

Use it for

  • Giving a page a friendly image.

Skip it when

  • Photographs are needed.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/illustrations

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 { Illustration } from "@/components/ui/illustrations"

The worked example comes with Pro

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

Checking your licence…

API reference #

Illustration

component

Also accepts the native props of its root element and a ref.

PropTypeDefault
name *IllustrationName—
titlestring—
sizenumber120

Accessibility #

It is built on native elements and keeps aria-label and aria-hidden in step with state.

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.