Gravity field

When to use #

Use it for

A playful interaction on a landing page.

Skip it when

Touch-first or reduced-motion experiences.

Installation #

terminal

pnpm dlx shadcn@latest add @caliper/gravity-field

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 { GravityField } from "@/components/ui/gravity-field"

The worked example comes with Pro

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

Checking your licence…

API reference #

GravityField

component

PropTypeDefaultDescription

options *readonly string[]—

value *readonly string[]—

onValueChange *(value: string[]) => void—

label *string—

gravitybooleantrue

shakeKeynumber0Change this number to shake the pile.

classNamestring—

It exposes group semantics, with aria-label and aria-pressed kept in step with state.

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

Motion #

It checks prefers-reduced-motion itself and settles immediately instead of travelling. Every state is still reachable.