> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes.heygen.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Directional Wipe

> A directional scene push that slides one panel over another.

export const InstallCommand = ({command}) => {
  const [copied, setCopied] = React.useState(false);
  const copy = async () => {
    try {
      if (navigator.clipboard && window.isSecureContext) {
        await navigator.clipboard.writeText(command);
      } else {
        const previous = document.activeElement;
        const scratch = document.createElement("textarea");
        scratch.value = command;
        scratch.setAttribute("readonly", "");
        scratch.style.position = "fixed";
        scratch.style.opacity = "0";
        document.body.appendChild(scratch);
        scratch.select();
        document.execCommand("copy");
        document.body.removeChild(scratch);
        previous?.focus?.();
      }
      setCopied(true);
      setTimeout(() => setCopied(false), 2000);
    } catch {}
  };
  return <div className="hf-install-command not-prose my-4 flex items-stretch overflow-hidden rounded-xl border border-zinc-200 bg-zinc-50 dark:border-zinc-800 dark:bg-zinc-900">
      <code className="flex-1 overflow-x-auto whitespace-nowrap border-r border-zinc-200 px-4 py-3 font-mono text-sm text-zinc-800 dark:border-zinc-800 dark:text-zinc-100">
        {command}
      </code>
      <button type="button" onClick={copy} data-copied={copied ? "true" : "false"} aria-label={`Copy ${command} to the clipboard`} className="hf-install-copy">
        <svg className="hf-install-copy-clipboard" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 18 18" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
          <path d="M14.25 5.25H7.25C6.14543 5.25 5.25 6.14543 5.25 7.25V14.25C5.25 15.3546 6.14543 16.25 7.25 16.25H14.25C15.3546 16.25 16.25 15.3546 16.25 14.25V7.25C16.25 6.14543 15.3546 5.25 14.25 5.25Z" />
          <path d="M2.80103 11.998L1.77203 5.07397C1.61003 3.98097 2.36403 2.96397 3.45603 2.80197L10.38 1.77297C11.313 1.63397 12.19 2.16297 12.528 3.00097" />
        </svg>
        <svg className="hf-install-copy-check" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 18 18" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
          <path d="M2.75 9.5L6.5 13.25L15.25 4.5" />
        </svg>
      </button>
      <span className="hf-install-copy-status" role="status" aria-live="polite">
        {copied ? "Copied" : ""}
      </span>
    </div>;
};

<iframe className="w-full aspect-video rounded-xl border-0 bg-zinc-100 dark:bg-zinc-800" title="directional-wipe preview" loading="lazy" srcDoc={`<!doctype html><html><head><meta charset="utf-8"><style>html,body{margin:0;height:100%;overflow:hidden;background:transparent}hyperframes-player{display:block;width:100%;height:100%}</style><script src="https://cdn.jsdelivr.net/npm/@hyperframes/player@0.7/dist/hyperframes-player.global.js"><\/script></head><body><script>fetch("/public/catalog/components/directional-wipe.json").then(function(r){return r.json()}).then(function(d){var p=document.createElement("hyperframes-player");p.setAttribute("srcdoc",d.html);p.setAttribute("controls","");p.setAttribute("autoplay","");p.setAttribute("loop","");p.setAttribute("muted","");p.setAttribute("poster","https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/directional-wipe.png");document.body.appendChild(p)});<\/script></body></html>`} />

## Install

<InstallCommand command="npx hyperframes add directional-wipe" />

That writes one file: `compositions/components/directional-wipe.html`.

## Variables

Every one of these has a default, so the piece works untouched. Set the ones you
want to change on the element:

| Variable  | Default   | Accepts                     | What it does                                                                                                                                      |
| --------- | --------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `palette` | `slate`   | `slate`, `teal`, `ember`    | Theme token for the ring marking the incoming panel. Slate rides --accent, teal --brand, ember --accent-2; each falls back to a neutral hairline. |
| `corner`  | `rounded` | `square`, `rounded`, `soft` | Corner radius of the transition card.                                                                                                             |

Set them with `data-variable-values` on the element that mounts it. These are the
defaults, so this behaves exactly like the preview above until you change one:

```html wrap theme={null}
<div
  data-composition-id="directional-wipe"
  data-composition-src="compositions/components/directional-wipe.html"
  data-variable-values='{"palette":"slate","corner":"rounded"}'
></div>
```

## Source

<Accordion title={`directional-wipe.html`}>
  ```html theme={null}
  <!--
    Directional Wipe - remocn component ported to HyperFrames authoring format.

    Paste the markup and CSS into a composition. Drive the timeline integration
    from a paused GSAP timeline so renders remain deterministic.

    Variables. The script below reads each one, falls back to the declared
    default on anything missing or unrecognised, and writes the result as a
    custom property the CSS consumes. The timeline recipe at the bottom is
    untouched by them.

      - palette (slate | teal | ember, default slate): ink of the ring that marks
        the incoming panel. Both panels are monochrome placeholder material; the
        ring is the one accent-coloured element. slate rides --accent, teal rides
        --brand, ember rides --accent-2, and each falls back to a neutral hairline
        so an unthemed composition renders in black and white.
      - corner (square | rounded | soft, default rounded): corner radius of the
        card. square is 0, rounded the original 30px, soft 56px.

    On every default the motion is unchanged.
  -->

  <div
    class="hf-remocn-directional-wipe"
    data-composition-variables='[
      { "id": "palette", "type": "enum", "role": "style", "label": "Palette", "description": "Theme token for the ring marking the incoming panel. Slate rides --accent, teal --brand, ember --accent-2; each falls back to a neutral hairline.", "default": "slate", "options": [{ "value": "slate", "label": "Slate" }, { "value": "teal", "label": "Teal" }, { "value": "ember", "label": "Ember" }] },
      { "id": "corner", "type": "enum", "role": "style", "label": "Corner", "description": "Corner radius of the transition card.", "default": "rounded", "options": [{ "value": "square", "label": "Square" }, { "value": "rounded", "label": "Rounded" }, { "value": "soft", "label": "Soft" }] }
    ]'
  >
    <div class="scene from">Before</div>
    <div class="scene to">Directional Wipe</div>
    <div class="fx"></div>
    <div class="rgb"></div>
  </div>

  <style>
    .hf-remocn-directional-wipe {
      --hf-accent: var(--accent, rgba(255, 255, 255, 0.28));
      --hf-l1: rgba(255, 255, 255, 0.72);
      --hf-l3: rgba(255, 255, 255, 0.18);
      --hf-l4: rgba(255, 255, 255, 0.08);
      --hf-hair: rgba(255, 255, 255, 0.14);
      --hf-ink: #111827;
      --hf-muted: #6b7280;
      --hf-surface: #ffffff;
      color: var(--hf-ink);
      font-family: Inter, system-ui, sans-serif;
    }
    .hf-remocn-directional-wipe {
      position: relative;
      width: 760px;
      height: 428px;
      overflow: hidden;
      border-radius: var(--hf-corner, 30px);
      background: #111827;
      box-shadow: 0 28px 80px rgba(15, 23, 42, 0.2);
    }
    .hf-remocn-directional-wipe .scene {
      position: absolute;
      inset: 0;
      display: grid;
      place-items: center;
      font-weight: 900;
      font-size: 58px;
      letter-spacing: -0.05em;
      color: #fff;
    }
    .hf-remocn-directional-wipe .from {
      background:
        repeating-linear-gradient(90deg, rgba(255, 255, 255, 0.04) 0 1px, transparent 1px 4px),
        var(--hf-l4);
      transform: translate(var(--hf-from-x, 0px), var(--hf-from-y, 0px))
        scale(var(--hf-from-scale, 1));
      filter: blur(var(--hf-from-blur, 0px));
    }
    .hf-remocn-directional-wipe .to {
      background:
        repeating-linear-gradient(90deg, rgba(255, 255, 255, 0.05) 0 1px, transparent 1px 4px),
        var(--hf-l3);
      box-shadow: inset 0 0 0 2px var(--hf-accent);
      transform: translate(var(--hf-to-x, 0px), var(--hf-to-y, 0px)) scale(var(--hf-to-scale, 1));
      clip-path: inset(
        var(--hf-clip-top, 0%) var(--hf-clip-right, 100%) var(--hf-clip-bottom, 0%)
          var(--hf-clip-left, 0%)
      );
    }
    .hf-remocn-directional-wipe .fx {
      position: absolute;
      inset: 0;
      background: linear-gradient(90deg, transparent, rgba(255, 255, 255, 0.75), transparent);
      mix-blend-mode: screen;
      transform: translateX(var(--hf-fx-x, -110%));
    }
    .hf-remocn-directional-wipe .rgb {
      position: absolute;
      inset: 0;
      pointer-events: none;
      opacity: var(--hf-rgb-opacity, 0);
      background: linear-gradient(
        90deg,
        rgba(239, 68, 68, 0.35),
        transparent,
        rgba(34, 211, 238, 0.35)
      );
      transform: translateX(var(--hf-rgb-x, 0px));
    }
  </style>

  <script>
    (function () {
      "use strict";

      var vars =
        window.__hyperframes && window.__hyperframes.getVariables
          ? window.__hyperframes.getVariables()
          : {};

      // Unrecognised overrides fall back to their declared defaults.
      // Theme tokens only. The neutral fallback keeps an unthemed mount monochrome.
      var HAIRLINE = "rgba(255, 255, 255, 0.28)";
      var palettes = {
        slate: "var(--accent, " + HAIRLINE + ")",
        teal: "var(--brand, " + HAIRLINE + ")",
        ember: "var(--accent-2, " + HAIRLINE + ")",
      };
      var corners = { square: "0px", rounded: "30px", soft: "56px" };

      function pick(table, value, fallback) {
        return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
      }

      var palette = palettes[pick(palettes, vars.palette, "slate")];
      var corner = corners[pick(corners, vars.corner, "rounded")];

      var roots = document.querySelectorAll(".hf-remocn-directional-wipe");
      for (var i = 0; i < roots.length; i += 1) {
        roots[i].style.setProperty("--hf-accent", palette);
        roots[i].style.setProperty("--hf-corner", corner);
      }
    })();
  </script>

  <!--
    Timeline integration:
    tl.fromTo('.hf-remocn-directional-wipe .to', { '--hf-clip-right': '100%', '--hf-to-x': '60px', '--hf-to-scale': 1.04 }, { '--hf-clip-right': '0%', '--hf-to-x': '0px', '--hf-to-scale': 1, duration: 0.9, ease: 'power3.inOut' }, startTime); tl.to('.hf-remocn-directional-wipe .from', { '--hf-from-x': '-70px', '--hf-from-scale': 0.96, '--hf-from-blur': '5px', duration: 0.9, ease: 'power3.inOut' }, startTime); tl.fromTo('.hf-remocn-directional-wipe .fx', { '--hf-fx-x': '-110%' }, { '--hf-fx-x': '110%', duration: 0.58, ease: 'power2.inOut' }, startTime + 0.18); tl.fromTo('.hf-remocn-directional-wipe .rgb', { '--hf-rgb-opacity': 0, '--hf-rgb-x': '-16px' }, { '--hf-rgb-opacity': 1, '--hf-rgb-x': '16px', repeat: 3, yoyo: true, duration: 0.07, ease: 'steps(1)' }, startTime + 0.32);
  -->
  ```
</Accordion>

## Usage

Open `compositions/components/directional-wipe.html` and paste its contents into your composition. See the comment header in the file for timeline integration guidance.

Tagged `transition-primitive` `remocn-port`.

## Related topics

* [Browse the complete Catalog](/catalog)
* [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
* [Build a richer composition](/go-further)


## Related topics

- [Clip Wipe](/catalog/components/caption-clip-wipe.md)
- [Chromatic Aberration Wipe](/catalog/components/chromatic-aberration-wipe.md)
- [Before After Wipe](/catalog/components/before-after-wipe.md)
