caliper uidocs

Media player

Pro

An audio or video player with accessible controls and a progress bar.

Installs components/ui/media-player.tsxDepends on @radix-ui/react-popover, lucide-reactMotion shared motion tokens
pnpm dlx shadcn@latest add @caliper/media-player

Space plays, arrows skip and change volume, comma and period change speed.

When to use #

Use it for

  • Playing a recording inside the product.
  • Captions or chapters are available.

Skip it when

  • The media is background decoration.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/media-player

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 { MediaPlayer } from "@/components/ui/media-player"

The worked example comes with Pro

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

Checking your licence…

API reference #

MediaPlayer

component
PropTypeDefaultDescription
src *string—
kind"audio" | "video""audio"
title *string—
artworkReactNode—Shown behind the controls for audio.
chaptersreadonly Chapter[][]
classNamestring—

Accessibility #

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

Keyboard and focus handling comes from Radix popover: arrow keys move through items, Enter and Space select, and Escape closes and returns focus.

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.