Workspace / effect / overlay

Peel

Peels your live HTML back from a chosen edge on hover, revealing a second layer underneath.

Workspaceeffectoverlay

npx shadcn@latest add @pax-sh/peel-reactlocal only

Tier: medium. Reduced motion: hard edge reveal

Peel.tsx
"use client";

import { useEffect, useRef } from "react";
import { peelEffect } from "@pax-sh/effects";

export interface PeelProps {
  className?: string;
  reducedMotion?: boolean;
  tier?: "low" | "medium" | "high";
  children?: React.ReactNode;
}

export function Peel(props: PeelProps) {
  const rootRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const target = rootRef.current;
    if (!target) return;
    const instance = peelEffect.mount(target, {
      className: props.className,
      reducedMotion: props.reducedMotion,
      tier: props.tier,
    });
    return () => instance.dispose();
  }, [props.className, props.reducedMotion, props.tier]);

  return (
    <div ref={rootRef} className={props.className} data-pax-effect="peel">
      {props.children}
    </div>
  );
}