Skip to content
MIZU.

MediaPlayer

Playback handed to the browser's accessible controls.

View .md

Live — this one is real

A four-second calibration tone

Usage

tsx
import { MediaPlayer } from "mizu-ui";

export function Example() {
  const src = "/audio/calibration.wav";
  return (
    <MediaPlayer
      kind="audio"
      label="A four-second calibration tone"
      src={src}
      preload="metadata"
    />
  );
}

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

sh
npx shadcn@latest add 0xuser64bit/mizu/media-player

Every component imports from its own path, its name in kebab case. Its source, content/Media.tsx, also holds Avatar and ImageFigure. Each has its own command and path; adding one after this copies only its small entry file. To paste the example, replace its mizu-ui import with:

tsx
import { MediaPlayer } from "@/components/ui/mizu/media-player";

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Client Component: its source starts with “use client”.

Inspect content/Media.tsx

Source is included in the npm package under src/content/Media.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
kind"audio" | "video""video"Native media element.
labelstring—Figure and player name.
srcstring—Playable media URL. The example uses public/audio/calibration.wav from this repository; copy it to your app's public/audio folder or supply your own source. The npm package and registry do not install media assets.
...props / childrenVideoHTMLAttributes / ReactNode—Native source, poster, tracks, events; children may include caption tracks.

Accessibility

Native controls support keyboard and touch. Provide captions/transcripts for speech and video. Autoplay is opt-in through native props.

Motion

Playback follows user intent; no synthetic timer.

Works alongside

AvatarKbdCodeBlockQuote