Skip to content
MIZU.

AspectRatio

Reserve media space before it arrives, keeping the surrounding reading rhythm steady.

View .md

Live — this one is real

A diamond measurement field

Usage

tsx
import { AspectRatio } 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 (
    <AspectRatio ratio={2}>
      <img
        src={field("#141413", "#7e776b")}
        alt="A diamond measurement field"
      />
    </AspectRatio>
  );
}

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/aspect-ratio

Every component imports from its own path, its name in kebab case. Its source, layout/Layout.tsx, also holds Stack, Grid, ScrollArea and AppShell. 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 { AspectRatio } from "@/components/ui/mizu/aspect-ratio";

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 Server Component: it renders on the server, with no client JavaScript of its own.

Inspect layout/Layout.tsx

Source is included in the npm package under src/layout/Layout.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
rationumber16 / 9Width divided by height.
children / ...propsReactNode / HTMLAttributes—Native wrapper and media.

Accessibility

CSS aspect-ratio reserves space; invalid ratios fall back to a square. Content retains its own accessibility.

Motion

Static geometry.

Works alongside