Skip to content
MIZU.

Stat

A metric with context: direction and favorability are separate decisions.

View .md

Live — this one is real

Illustrative build duration

1.2s

18% example decrease

Synthetic readings, not a Mizu performance measurement.

Usage

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

export function Example() {
  return (
    <Stat
      label="Illustrative build duration"
      value="1.2s"
      change={{
        value: "18% example decrease",
        direction: "down",
        favorable: true,
      }}
      detail="Synthetic readings, not a Mizu performance measurement."
    />
  );
}

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/stat

Every component imports from its own path, its name in kebab case. Its source, data/Records.tsx, also holds DescriptionList, Timeline and ComparisonTable. 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 { Stat } from "@/components/ui/mizu/stat";

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 data/Records.tsx

Source is included in the npm package under src/data/Records.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
label / valuestring / ReactNode—Metric name and reading.
change{value, direction, favorable?}—Text, trend and whether that trend is desirable.
detailstring—Supporting context.

Accessibility

The direction is readable and announced independently of color. A falling value is not automatically bad.

Motion

Static measurement.

Works alongside