> ## 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.

# Soft Blur In

> A soft opacity, blur, and lift reveal for headlines, captions, and product UI callouts

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="soft-blur-in 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/soft-blur-in.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/soft-blur-in.png");document.body.appendChild(p)});<\/script></body></html>`} />

## Install

<InstallCommand command="npx hyperframes add soft-blur-in" />

That writes one file: `compositions/components/soft-blur-in.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                                                                                       |
| ----------- | ---------- | --------------------------- | -------------------------------------------------------------------------------------------------- |
| `distance`  | `standard` | `close`, `standard`, `far`  | How far the element is offset before it slides home: 14px, 28px or 52px.                           |
| `direction` | `up`       | `up`, `down`                | up starts the element below its resting place so it rises in, down starts it above so it drops in. |
| `blur`      | `standard` | `soft`, `standard`, `heavy` | Starting blur radius, from a light haze to a full smear.                                           |

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="soft-blur-in"
  data-composition-src="compositions/components/soft-blur-in.html"
  data-variable-values='{"distance":"standard","direction":"up","blur":"standard"}'
></div>
```

## Source

<Accordion title={`soft-blur-in.html`}>
  ```html theme={null}
  <!--
    Soft Blur In - web-native motion primitive.

    Usage:
    1. Add class="hf-soft-blur-in" to the element you want to reveal.
    2. Paste this style block and script once.
    3. Add the timeline snippet to your paused GSAP timeline.

    Variables. The script reads each one, falls back to the declared default on
    anything missing or unrecognised, and writes the result as a custom property
    on the document root, which every element carrying the class inherits. These
    set where the reveal STARTS: the timeline snippet below still drives offset
    and blur to zero, so each knob decides how far and how hazy the element is
    before it settles, not how long it takes.

      - distance (close | standard | far, default standard): how far the element
        is offset before it slides home, 14px, 28px or 52px.
      - direction (up | down, default up): up starts the element below its
        resting place so it rises in, down starts it above so it drops in.
      - blur (soft | standard | heavy, default standard): the starting blur
        radius, 8px, 18px or 34px, from a light haze to a full smear.

    On every default the result is identical to the original: the element starts
    28px low behind an 18px blur.
  -->

  <style
    data-composition-variables='[
      { "id": "distance", "type": "enum", "role": "motion", "label": "Distance", "description": "How far the element is offset before it slides home: 14px, 28px or 52px.", "default": "standard", "options": [{ "value": "close", "label": "Close" }, { "value": "standard", "label": "Standard" }, { "value": "far", "label": "Far" }] },
      { "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "up starts the element below its resting place so it rises in, down starts it above so it drops in.", "default": "up", "options": [{ "value": "up", "label": "Up" }, { "value": "down", "label": "Down" }] },
      { "id": "blur", "type": "enum", "role": "style", "label": "Blur", "description": "Starting blur radius, from a light haze to a full smear.", "default": "standard", "options": [{ "value": "soft", "label": "Soft" }, { "value": "standard", "label": "Standard" }, { "value": "heavy", "label": "Heavy" }] }
    ]'
  >
    .hf-soft-blur-in {
      opacity: 0;
      transform: translate3d(0, var(--hf-soft-blur-y, 28px), 0);
      filter: blur(var(--hf-soft-blur-radius, 18px));
      will-change: transform, opacity, filter;
    }
  </style>

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

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

      // Unrecognised overrides return to their declared defaults.
      function pick(table, value, fallback) {
        return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
      }

      var distances = { close: 14, standard: 28, far: 52 };
      var directions = { up: 1, down: -1 };
      var blurs = { soft: 8, standard: 18, heavy: 34 };

      var distance = distances[pick(distances, vars.distance, "standard")];
      var direction = directions[pick(directions, vars.direction, "up")];
      var blur = blurs[pick(blurs, vars.blur, "standard")];

      // Set on the root so every element carrying the class inherits the values,
      // whether it exists yet or not.
      var root = document.documentElement;
      root.style.setProperty("--hf-soft-blur-y", distance * direction + "px");
      root.style.setProperty("--hf-soft-blur-radius", blur + "px");
    })();
  </script>

  <!--
    Timeline integration:

    tl.to(".hf-soft-blur-in", {
      opacity: 1,
      y: 0,
      filter: "blur(0px)",
      duration: 0.8,
      ease: "power3.out",
      stagger: 0.08,
    }, startTime);
  -->
  ```
</Accordion>

## Usage

Open `compositions/components/soft-blur-in.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.

Tagged `motion-primitive` `text` `reveal` `blur`.

## 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

- [Focus Blur Resolve](/catalog/components/focus-blur-resolve.md)
- [Blur Out Up](/catalog/components/blur-out-up.md)
- [Blur In](/catalog/components/blur-in.md)
