caliper uidocs

Sidebar rail

Pro

A narrow icon rail that expands.

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

Northwind

Home

Use the arrow keys in the sidebar to move between pages, and Left and Right to fold a section. Pin a page to keep it in the Pinned list.

When to use #

Use it for

  • Space-constrained navigation.

Skip it when

  • Labels matter.

Installation #

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

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 { SidebarRail } from "@/components/ui/sidebar-rail"

The worked example comes with Pro

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

Checking your licence…

API reference #

SidebarRail

component
PropTypeDefault
items *readonly RailItem[]—
bottomreadonly RailItem[][]
activeId *string—
onNavigate *(id: string) => void—
pinnedboolean—
onPinnedChange((pinned: boolean) => void)—
logoReactNode—
labelstring"Primary"
classNamestring—

Accessibility #

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

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.