caliper uidocs

Inbox sidebar

Pro

The folders, labels and counts of an inbox.

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

When to use #

Use it for

  • Navigation for a mail-like app.

Skip it when

  • There are no groups.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/inbox-sidebar

Adds its 3 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 { InboxSidebar } from "@/components/ui/inbox-sidebar"

The worked example comes with Pro

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

Checking your licence…

API reference #

InboxSidebar

component
PropTypeDefault
folders *readonly InboxFolder[]—
labelsreadonly InboxLabel[][]
activeId *string—
onSelect *(id: string) => void—
onCompose *() => void—
classNamestring—

Accessibility #

It is built on native elements and keeps aria-current, aria-label, aria-hidden and aria-expanded 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.