Setup guide

Pro

Onboarding that waits until wanted: a corner launcher shows setup progress and opens into the checklist, with the next step open and its action ready.

Installs components/ui/setup-guide.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source

pnpm dlx shadcn@latest add @caliper/setup-guide

Your workspace

When to use #

Use it for

New workspaces with four to eight setup steps.
Products where setup happens across several screens.

Skip it when

A single required step; ask for it directly.

Installation #

terminal

pnpm dlx shadcn@latest add @caliper/setup-guide

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.

example.tsx

import { SetupGuide } from "@/components/ui/setup-guide"

The worked example comes with Pro

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

Checking your licence…

API reference #

SetupGuide

component

PropTypeDefaultDescription

steps *readonly SetupStep[]—

titlestring"Get set up"

position"fixed" | "absolute""fixed""absolute" places it in its nearest positioned parent.

onDismiss(() => void)—Offered once everything is done.

classNamestring—

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.