caliper uidocs

Invite flow

Pro

Add emails, choose a role and send invites.

Installs components/ui/invite-flow.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/invite-flow
  1. People
  2. Role
  3. Review

Press Enter or comma after each address, or paste a list.

5 of 5 seats would remain.

Try pasting a list, a typo, an existing member, or an address that starts with “bounce”.

When to use #

Use it for

  • Adding teammates.

Skip it when

  • People are added from a directory.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/invite-flow

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 { InviteFlow } from "@/components/ui/invite-flow"

The worked example comes with Pro

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

Checking your licence…

API reference #

InviteFlow

component
PropTypeDefaultDescription
roles *readonly InviteRole[]—
membersreadonly string[][]Emails that already belong to the team.
seatsLeftnumber—Seats you can still fill. Omit when seats are unlimited.
onSend *(invites: { email: string; role: string; message: string; }[]) => void | InviteResult | Promise<void | InviteResult>—
classNamestring—

Accessibility #

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

KeyBehaviour
BackspaceRemoves the previous character or item.

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.