Skip to content
MIZU.

Stepper

A numbered journey with a clear present step.

View .md

Live — this one is real

  1. Choose the package
  2. Check the details
  3. Publish when ready

Usage

tsx
"use client";

import { useState } from "react";
import { Stepper } from "mizu-ui";

export function Example() {
  const [step, setStep] = useState("review");
  return (
    <Stepper
      current={step}
      onStepChange={setStep}
      steps={[
        { id: "prepare", label: "Prepare", description: "Choose the package" },
        { id: "review", label: "Review", description: "Check the details" },
        { id: "release", label: "Release", description: "Publish when ready" },
      ]}
    />
  );
}

It starts with "use client" because it keeps state or passes functions to components, so it pastes into a Next.js page as it is. Other React setups ignore the directive.

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

Every component imports from its own path, its name in kebab case. Its source, navigation/Navigation.tsx, also holds Breadcrumbs, Pagination, AnchorNav, SideNav and BottomNav. 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 { Stepper } from "@/components/ui/mizu/stepper";

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 navigation/Navigation.tsx

Source is included in the npm package under src/navigation/Navigation.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
steps{id,label,description?,disabled?}[]—Ordered steps.
currentstring—Current step id.
onStepChangefunction—Optional navigation; omit for a static indicator.

Accessibility

Ordered list with aria-current step. Buttons are optional; progression rules belong to the caller.

Motion

CSS transitions explain state changes. Reduced motion removes travel.

Works alongside