caliper uidocs

Kanban board

Pro

Drag cards between columns with limits.

Installs components/ui/kanban-board.tsxDepends on lucide-reactMotion shared motion tokens
pnpm dlx shadcn@latest add @caliper/kanban-board

To do

3
  • Write the migration guidemediumdocs
  • Audit focus rings on dark themehigha11y
  • Add keyboard shortcuts page

In progress

2/2
  • Virtualise the orders tablehighperf
  • Refresh the pricing page

In review

1
  • Billing: usage forecastbilling

Done

1
  • Set up visual regression tests

When to use #

Use it for

  • Moving work through stages.

Skip it when

  • Items have no stages.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/kanban-board

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 { KanbanBoard } from "@/components/ui/kanban-board"

The worked example comes with Pro

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

Checking your licence…

API reference #

KanbanBoard

component
PropTypeDefault
columns *readonly KanbanColumn[]—
onChange *(columns: KanbanColumn[]) => void—
onAdd((columnId: string, title: string) => void)—
labelstring"Board"
classNamestring—

Accessibility #

It exposes group, button and status semantics, with aria-label, aria-hidden, aria-pressed and aria-roledescription kept in step with state. Changes that matter are announced through a live region.

KeyBehaviour
SpaceActivates the focused control.
EnterActivates the focused control.
→Moves to the next item or value.
←Moves to the previous item or value.
↓Moves to the next item or value.
↑Moves to the previous item or value.
EscapeCloses or cancels, then returns focus to where it came from.

Motion #

Transitions use the shared duration and easing tokens. Under prefers-reduced-motion those tokens collapse to instant and travel distances go to zero, so state changes still happen without movement.