PageWipe

The page transition — a full-screen sweep with a label, and an imperative API that hands you the midpoint.

Live — this one is real

Full-screen sweep — navigate at the midpoint

Usage

tsx

"use client";

import type { ReactNode } from "react";
import { Button, PageWipeProvider, usePageWipe } from "mizu-ui";

export function App({ children }: { children: ReactNode }) {
  return <PageWipeProvider>{children}</PageWipeProvider>;
}

export function NavLink() {
  const { wipe } = usePageWipe();

  const go = async () => {
    await wipe("The lab");
    window.location.assign("/lab");
  };

  return <Button onClick={go}>Enter</Button>;
}

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.

npx shadcn@latest add 0xuser64bit/mizu/page-wipe 0xuser64bit/mizu/button

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

Every component imports from its own path, its name in kebab case. To paste the example, replace its mizu-ui import with:

tsx

import { PageWipeProvider, usePageWipe } from "@/components/ui/mizu/page-wipe";
import { Button } from "@/components/ui/mizu/button";

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/PageWipe.tsx

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

Open full source ↗

Props

Prop	Type	Default	Description
wipe	(label?: string) => Promise<void>	—	Starts the sweep. The promise resolves at the midpoint — navigate then.

Accessibility

The overlay is aria-hidden and pointer-events:none. Under reduced motion the promise resolves immediately with no visual.

Motion

1.05s wipe easing sweep; the label fades in and out with the cover.

Works alongside

MaskLine Reveal Magnetic Marquee