Skip to content
MIZU.

Parallax

A bounded depth cue linked to the surface's actual position in the viewport.

View .md

Live — this one is real

A field of measurement diamonds
Scroll the page to study the relationship.

Usage

tsx
import { Parallax, ImageFigure } from "mizu-ui";

export function Example() {
  const field = (ground: string, mark: string) =>
    `data:image/svg+xml,${encodeURIComponent(`<svg xmlns="http://www.w3.org/2000/svg" width="720" height="360"><pattern id="d" width="36" height="36" patternUnits="userSpaceOnUse"><path d="M18 13l5 5-5 5-5-5z" fill="${mark}"/></pattern><rect width="720" height="360" fill="${ground}"/><rect width="720" height="360" fill="url(#d)"/></svg>`)}`;
  return (
    <Parallax distance={35}>
      <ImageFigure
        src={field("#141413", "#7e776b")}
        alt="A field of measurement diamonds"
        caption="Scroll the page to study the relationship."
        width={720}
        height={360}
      />
    </Parallax>
  );
}

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/parallax 0xuser64bit/mizu/image-figure

The example also uses ImageFigure, so the command adds it too.

Every component imports from its own path, its name in kebab case. Its source, motion/Scroll.tsx, also holds ScrollProgress. 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 { Parallax } from "@/components/ui/mizu/parallax";
import { ImageFigure } from "@/components/ui/mizu/image-figure";

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. Requires React and Motion. A Client Component: its source starts with “use client”.

Inspect motion/Scroll.tsx

Source is included in the npm package under src/motion/Scroll.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
distancenumber40Travel around rest in pixels, bounded to ±120.
children / classNameReactNode / string—Prefer decorative media and stable surrounding text.

Accessibility

No essential information depends on movement. Overflow contains the visual travel; children retain their own semantics.

Motion

Motion's managed scroll subscription maps start/end positions directly. Reduced motion shows the resting state.

Works alongside

MaskLineRevealMagneticMarquee