Skip to content
MIZU.

ImageFigure

Responsive imagery with a caption and a visible failure state.

View .md

Live — this one is real

Warm diamonds arranged on a dark measurement field
Field study 01 — a repeatable spacing rhythm.

Usage

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

export function Example() {
  const field = (ground: string, mark: string) =>
    `data:image/svg+xml,${encodeURIComponent(`<svg xmlns="http://www.w3.org/2000/svg" width="720" height="360"><pattern id="d" width="36" height="36" patternUnits="userSpaceOnUse"><path d="M18 13l5 5-5 5-5-5z" fill="${mark}"/></pattern><rect width="720" height="360" fill="${ground}"/><rect width="720" height="360" fill="url(#d)"/></svg>`)}`;
  return (
    <ImageFigure
      src={field("#141413", "#7e776b")}
      alt="Warm diamonds arranged on a dark measurement field"
      caption="Field study 01 — a repeatable spacing rhythm."
      width={720}
      height={360}
    />
  );
}

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/image-figure

Every component imports from its own path, its name in kebab case. Its source, content/Media.tsx, also holds Avatar and MediaPlayer. 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 { ImageFigure } from "@/components/ui/mizu/image-figure";

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
src / altstring—Resource URL and meaningful image description.
captionReactNode—Optional visible context.
...propsImgHTMLAttributes—Native image attributes, including dimensions and srcSet.

Accessibility

Native figure/image/caption; lazy by default. Supply dimensions to prevent shifts. Failed images retain the description.

Motion

Static media.

Works alongside

AvatarKbdCodeBlockQuote