Skip to content
MIZU.

SideNav

Grouped destinations with the current place held in focus.

View .md

Live — this one is real

Usage

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

export function Example() {
  return (
    <SideNav
      currentPath="/components"
      groups={[
        {
          label: "Discover",
          items: [
            { label: "Collection", href: "/components" },
            { label: "Getting started", href: "/components/getting-started" },
          ],
        },
        {
          label: "Experiment",
          items: [
            { label: "Lab", href: "/lab" },
            { label: "Studio", href: "/studio" },
          ],
        },
      ]}
    />
  );
}

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/side-nav

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

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
groups{label: string; items: NavigationItem[]}[]—Named groups with native links.
currentPathstring—Exact href of the current page.
labelstring—Navigation landmark.

Accessibility

Real anchors and aria-current page. Decorative icons are hidden; link labels stay visible.

Motion

CSS transitions explain state changes. Reduced motion removes travel.

Works alongside