Skip to content
MIZU.

Badge

A compact, bordered label for metadata and status.

View .md

Live — this one is real

NewStableDraft

Usage

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

export function Example() {
  return (
    <div style={{ display: "flex", gap: 12, flexWrap: "wrap" }}>
      <Badge tone="accent">New</Badge>
      <Badge tone="paper">Stable</Badge>
      <Badge>Draft</Badge>
    </div>
  );
}

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

Every component imports from its own path, its name in kebab case. To paste the example, replace its mizu-ui import with:

tsx
import { Badge } from "@/components/ui/mizu/badge";

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 ui/Badge.tsx

Source is included in the npm package under src/ui/Badge.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
tone"paper" | "muted" | "accent" | "line""muted"Label treatment.
diamondbooleantrueShow the decorative marker.

Accessibility

State remains visible text. Add a live region only when the status changes dynamically.

Motion

Static text.

Works alongside