caliper uidocs

Peek preview

Pro

A look without leaving the list: press and hold a row and its preview rises from where you pressed; let go and it sinks back. Shift+Space from the keyboard.

Installs components/ui/peek-preview.tsxDepends on none beyond ReactMotion none in component source
pnpm dlx shadcn@latest add @caliper/peek-preview
  • Press and hold, or Shift and Space, to preview.
  • Press and hold, or Shift and Space, to preview.
  • Press and hold, or Shift and Space, to preview.

Hold a row to peek; click to open.

When to use #

Use it for

  • Mail, files and messages people triage.
  • Lists where opening an item costs a page load.

Skip it when

  • The only way to read an item; a click must still open it.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/peek-preview

Adds its 2 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 { PeekPreview } from "@/components/ui/peek-preview"

The worked example comes with Pro

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

Checking your licence…

API reference #

PeekPreview

component
PropTypeDefaultDescription
label *string—What the row is, e.g. the message subject.
preview *ReactNode—
onOpen(() => void)—A normal click: open the item properly.
holdMsnumber380
classNamestring—
children *ReactNode—

Accessibility #

It exposes dialog semantics, with aria-describedby, aria-expanded and aria-label kept in step with state.

KeyBehaviour
SpaceActivates the focused control.
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.