Skip to content
MIZU.

ImageCompare

Reveal two versions with a divider that follows your hand.

View .md

Live — this one is real

Surface study
Ink surface with muted diamondsPaper surface with warm diamonds
Ink50% paperPaper

Usage

tsx
"use client";

import { useState } from "react";
import { ImageCompare } 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>`)}`;
  const [value, setValue] = useState(50);
  return (
    <ImageCompare
      label="Surface study"
      before={{
        src: field("#141413", "#7e776b"),
        alt: "Ink surface with muted diamonds",
      }}
      after={{
        src: field("#f4f0e8", "#93877a"),
        alt: "Paper surface with warm diamonds",
      }}
      value={value}
      onValueChange={setValue}
      beforeLabel="Ink"
      afterLabel="Paper"
    />
  );
}

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/image-compare

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

tsx
import { ImageCompare } from "@/components/ui/mizu/image-compare";

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 interaction/ImageCompare.tsx

Source is included in the npm package under src/interaction/ImageCompare.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
before / after{src: string; alt: string}—Images with matching composition and dimensions.
value / onValueChangenumber / function—Controlled reveal percentage, 0–100.
label / beforeLabel / afterLabelstring—Figure and version names.

Accessibility

Pointer capture enables direct dragging; a labelled native range gives keyboard and touch control. Both images retain descriptions. Load failure disables the reveal with an explained state.

Motion

Direct clipping with no decorative loop.

Works alongside

ComboboxMultiSelectInlineEditRangeSelector