AnchorNav

A page outline that follows the section in view.

View .md

Live — this one is real

Introduction

Navigation follows the document.

Details

Every item is a native fragment link.

Usage

tsx

import { AnchorNav } from "mizu-ui";

export function Example() {
  return (
    <div>
      <AnchorNav
        items={[
          { id: "anchor-intro", label: "Introduction" },
          { id: "anchor-details", label: "Details" },
        ]}
      />
      <section id="anchor-intro">
        <h3>Introduction</h3>
        <p>Navigation follows the document.</p>
      </section>
      <section id="anchor-details">
        <h3>Details</h3>
        <p>Every item is a native fragment link.</p>
      </section>
    </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.

npx shadcn@latest add 0xuser64bit/mizu/anchor-nav

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

Prop	Type	Default	Description
items	{id: string; label: string}[]	—	Existing document section ids.
label	string	—	Landmark name.

Accessibility

Native fragment links work without an observer. IntersectionObserver marks the visible location and disconnects on unmount.

Motion

Native scrolling; respects the document's scrolling settings.

Works alongside

Breadcrumbs Pagination Stepper SideNav