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

# Dynamic Grid

> A responsive animated grid background driven by CSS variables for SaaS, code, and data scenes

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

## Install

<InstallCommand command="npx hyperframes add dynamic-grid" />

That writes one file: `compositions/components/dynamic-grid.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                                                                                                                  |
| --------- | ---------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| `density` | `standard` | `fine`, `standard`, `coarse`         | Cell size of the grid: fine reads as graph paper, coarse as a few large panels.                                               |
| `weight`  | `hairline` | `hairline`, `standard`, `bold`       | Thickness of the grid lines, from a hairline rule to a bold structural grid.                                                  |
| `tone`    | `neutral`  | `neutral`, `green`, `blue`, `violet` | Line colour: neutral is the translucent white the original ships with, and the accents ride --brand, --accent and --accent-2. |

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="dynamic-grid"
  data-composition-src="compositions/components/dynamic-grid.html"
  data-variable-values='{"density":"standard","weight":"hairline","tone":"neutral"}'
></div>
```

## Source

<Accordion title={`dynamic-grid.html`}>
  ```html theme={null}
  <!--
    Dynamic Grid - animated background primitive.

    Paste the grid as the first child of a scene. Animate --hf-grid-x,
    --hf-grid-y, and --hf-grid-opacity from 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
    the CSS consumes. The timeline recipe below is untouched by them: it keeps
    driving the scroll offset and the opacity.

      - density (fine | standard | coarse, default standard): cell size of the
        grid, 44px, 72px or 112px. fine reads as graph paper, coarse as a few
        large panels.
      - weight (hairline | standard | bold, default hairline): line thickness,
        1px, 2px or 3px.
      - tone (neutral | green | blue | violet, default neutral): line colour.
        neutral is the translucent white the original ships with, and the three
        accents ride --brand, --accent and --accent-2.

    On every default the result is identical to the original: 72px cells drawn
    in 1px translucent white lines.
  -->

  <div
    class="hf-dynamic-grid"
    aria-hidden="true"
    data-composition-variables='[
      { "id": "density", "type": "enum", "role": "style", "label": "Density", "description": "Cell size of the grid: fine reads as graph paper, coarse as a few large panels.", "default": "standard", "options": [{ "value": "fine", "label": "Fine" }, { "value": "standard", "label": "Standard" }, { "value": "coarse", "label": "Coarse" }] },
      { "id": "weight", "type": "enum", "role": "style", "label": "Weight", "description": "Thickness of the grid lines, from a hairline rule to a bold structural grid.", "default": "hairline", "options": [{ "value": "hairline", "label": "Hairline" }, { "value": "standard", "label": "Standard" }, { "value": "bold", "label": "Bold" }] },
      { "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Line colour: neutral is the translucent white the original ships with, and the accents ride --brand, --accent and --accent-2.", "default": "neutral", "options": [{ "value": "neutral", "label": "Neutral" }, { "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] }
    ]'
  ></div>

  <style>
    .hf-dynamic-grid {
      --hf-grid-size: 72px;
      --hf-grid-line: 1px;
      --hf-grid-color: rgba(255, 255, 255, 0.16);
      --hf-grid-x: 0px;
      --hf-grid-y: 0px;
      --hf-grid-opacity: 1;
      position: absolute;
      inset: 0;
      pointer-events: none;
      opacity: var(--hf-grid-opacity);
      background-image:
        linear-gradient(var(--hf-grid-color) var(--hf-grid-line), transparent var(--hf-grid-line)),
        linear-gradient(
          90deg,
          var(--hf-grid-color) var(--hf-grid-line),
          transparent var(--hf-grid-line)
        );
      background-size: var(--hf-grid-size) var(--hf-grid-size);
      background-position: var(--hf-grid-x) var(--hf-grid-y);
    }
  </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 sizes = { fine: "44px", standard: "72px", coarse: "112px" };
      var weights = { hairline: "1px", standard: "2px", bold: "3px" };
      var tones = {
        neutral: "rgba(255, 255, 255, 0.16)",
        green: "color-mix(in srgb, var(--brand, #34d399) 34%, transparent)",
        blue: "color-mix(in srgb, var(--accent, #38bdf8) 34%, transparent)",
        violet: "color-mix(in srgb, var(--accent-2, #a78bfa) 34%, transparent)",
      };

      var size = sizes[pick(sizes, vars.density, "standard")];
      var line = weights[pick(weights, vars.weight, "hairline")];
      var color = tones[pick(tones, vars.tone, "neutral")];

      var roots = document.querySelectorAll(".hf-dynamic-grid");
      for (var i = 0; i < roots.length; i += 1) {
        roots[i].style.setProperty("--hf-grid-size", size);
        roots[i].style.setProperty("--hf-grid-line", line);
        roots[i].style.setProperty("--hf-grid-color", color);
      }
    })();
  </script>

  <!--
    Timeline integration:

    tl.to(".hf-dynamic-grid", {
      "--hf-grid-x": "72px",
      "--hf-grid-y": "-72px",
      duration: 6,
      ease: "none",
    }, 0);
  -->
  ```
</Accordion>

## Usage

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

Tagged `video-primitive` `motion-primitive` `background` `grid` `ui`.

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

- [Liquid Background](/catalog/blocks/vfx-liquid-background.md)
- [Camera Punch-In](/catalog/components/yt-camera-move.md)
- [Changelog](/changelog.md)
