Virtual table

When to use #

Use it for

Large result sets with sorting, search and keyboard navigation.

Skip it when

There are a few dozen rows; use the data table.

Installation #

terminal

pnpm dlx shadcn@latest add @caliper/virtual-table

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 { VirtualTable } from "@/components/ui/virtual-table"

The worked example comes with Pro

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

Checking your licence…

API reference #

VirtualTable

component

PropTypeDefaultDescription

label *string—

rows *readonly T[]—

columns *readonly VirtualColumn<T>[]—

rowKey *(row: T) => string—

search((row: T) => string)—Text to match the search box against. Omit to hide the box.

searchLabelstring"Search"

rowHeightnumber40

heightnumber420

loadingboolean—

errorstring—

onActivate((row: T) => void)—Called on Enter or double click.

classNamestring—

It exposes grid, row, columnheader, gridcell, rowgroup, alert and status semantics, with aria-hidden, aria-label, aria-rowcount, aria-colcount, aria-multiselectable and aria-busy kept in step with state. Changes that matter are announced through a live region.

KeyBehaviour

↓Moves to the next item or value.

↑Moves to the previous item or value.

PageDownMoves by a larger step, or to the next page.

PageUpMoves by a larger step, or to the previous page.

HomeJumps to the first item or the minimum.

EndJumps to the last item or the maximum.

SpaceActivates the focused control.

EnterActivates the focused control.

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.