caliper uidocs

Stretch refresh

Pro

A pull-down gesture where the content stretches like elastic before refreshing.

Installs components/ui/stretch-refresh.tsxDepends on @radix-ui/react-slot, lucide-reactMotion shared motion tokens
pnpm dlx shadcn@latest add @caliper/stretch-refresh

Activity

  • Maya Chen Deployed build #240 to staging
  • Ravi Patel Deployed build #239 to staging
  • Noor Haddad Deployed build #238 to staging
  • Tomás Rivera Deployed build #237 to staging
  • Ingrid Solberg Deployed build #236 to staging

When to use #

Use it for

  • Mobile lists that reload on pull.

Skip it when

  • Desktop-only screens.
  • Reduced-motion users are the majority; offer a button.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/stretch-refresh

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 { StretchRefresh } from "@/components/ui/stretch-refresh"

The worked example comes with Pro

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

Checking your licence…

API reference #

StretchRefresh

component
PropTypeDefault
onRefresh *() => void | Promise<void>—
children *ReactNode—
labelstring"Feed"
classNamestring—

Accessibility #

It exposes status semantics, with aria-hidden kept in step with state. Changes that matter are announced through a live region.

No custom key handling; Tab and the native activation keys do the work.

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.