Orbit menu

When to use #

Use it for

A floating action with a few related choices.
Playful, touch-first interfaces.

Skip it when

There are many items or long labels.
Keyboard efficiency is the priority.

Installation #

terminal

pnpm dlx shadcn@latest add @caliper/orbit-menu

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 { OrbitMenu } from "@/components/ui/orbit-menu"

The worked example comes with Pro

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

Checking your licence…

API reference #

OrbitMenu

component

PropTypeDefaultDescription

labelstring"Quick actions"

items *readonly OrbitItem[]—

onSelect *(item: OrbitItem) => void—

radiusnumber88Distance from the center to each action, in pixels.

startAnglenumber-90Where the first action sits: -90 is straight up.

sweepnumber360How much of the circle is used. Less than 360 leaves a gap.

sizenumber52

classNamestring—

It exposes menu, none and menuitem semantics, with aria-label, aria-haspopup, aria-expanded, aria-controls and aria-hidden kept in step with state.

KeyBehaviour

EscapeCloses or cancels, then returns focus to where it came from.

→Moves to the next item or value.

↓Moves to the next item or value.

←Moves to the previous item or value.

↑Moves to the previous item or value.

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.