hyperframes/docs/catalog/components/dynamic-grid.mdx

---
title: "Dynamic Grid"
description: "A responsive animated grid background driven by CSS variables for SaaS, code, and data scenes"
mode: "frame"
---

import { CatalogDetail, CatalogSlot } from "/snippets/catalog-detail.jsx";
import { InstallCommand } from "/snippets/install-command.jsx";

<div className="hf-ve-static-head not-prose">
  <h1>Dynamic Grid</h1>
  <p>A responsive animated grid background driven by CSS variables for SaaS, code, and data scenes</p>
</div>

<CatalogDetail
  previewSrc="/public/catalog/components/dynamic-grid.json"
  compositionId="dynamic-grid"
  compositionSrc="compositions/components/dynamic-grid.html"
  title="Dynamic Grid"
  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"}]}]}
  meta={{"category":"Motion Primitives","badge":"Stable","codeLines":104}}
  attribution={{"path":"registry/components/dynamic-grid","tags":["video-primitive","motion-primitive","background","grid","ui"]}}
  hasCode
  rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/dynamic-grid/dynamic-grid.html"
>

<CatalogSlot slot="code">

```html dynamic-grid.html
<!--
  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);
-->
```

</CatalogSlot>

<CatalogSlot slot="install">

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

That writes one file: `compositions/components/dynamic-grid.html`.

</CatalogSlot>

</CatalogDetail>

<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">

## Paste it into your composition

Open `compositions/components/dynamic-grid.html` and copy what is inside into your own composition.
The file opens with a comment header that walks you through it.

A component has no size or duration of its own. It takes both from the composition
you paste it into.

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

{/* hf:generated-footer */}

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

## Related topics

- [Browse the complete Catalog](/catalog)
- [Add assets and Catalog items in the browser editor](/studio/assets-and-blocks)
- [Put blocks together into one video](/concepts/compositions)

</div>