Skip to content
MIZU.

Avatar

Identity at a glance, with initials that survive a missing image.

View .md

Live — this one is real

A small team, clearly named.

Usage

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

export function Example() {
  return (
    <div style={{ display: "flex", gap: 12, alignItems: "center" }}>
      <Avatar name="Mizu Workshop" />
      <Avatar name="Aya Mori" size={60} />
      <span className="mizu-field-hint">A small team, clearly named.</span>
    </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/avatar

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

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
namestring—Accessible identity and fallback initials.
src / sizestring / number44Optional image and diameter in pixels.

Accessibility

One named image; redundant initials are hidden. Failed images fall back to initials.

Motion

Static identity.

Works alongside