caliper uidocs
DemoSign inGet Pro

AI artifact

Pro

A side panel that shows a generated document or code, with copy and versions.

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

Onboarding checklist

Document · Version 3

Onboarding checklist

  1. Create your workspace
  2. Invite two teammates
  3. Connect a data source
  4. Build your first dashboard
  5. Turn on weekly email digests

When to use #

Use it for

  • An assistant produces something the user keeps working on.
  • You want the result separate from the chat.

Skip it when

  • The reply is short; keep it in the message.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/ai-artifact

Adds its 5 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 { AiArtifact } from "@/components/ui/ai-artifact"

The worked example comes with Pro

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

Checking your licence…

API reference #

AiArtifact

component
PropTypeDefaultDescription
title *string—
kind *string—For example "Document" or "Component".
versions *readonly ArtifactVersion[]—
onRestore((id: string) => void)—Called with the version to restore, which becomes a new latest version in your data.
filenamestring"artifact.txt"
classNamestring—

Accessibility #

It exposes tablist, tab, menu, menuitemradio, status and tabpanel semantics, with aria-label, aria-selected, aria-checked, aria-haspopup, aria-expanded and aria-hidden kept in step with state. Changes that matter are announced through a live region.

KeyBehaviour
EscapeCloses or cancels, then returns focus to where it came from.

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.