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

# Grain Field

> A clearly visible accent-tinted dot field drifts over a subtle luminance gradient in an exact ambient loop.

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

## Install

<InstallCommand command="npx hyperframes add grain-field" />

That writes one file: `compositions/components/grain-field.html`.

## Paste it into your composition

Open `compositions/components/grain-field.html` and copy what is inside into your own composition.

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` | `fine`  | `fine`, `coarse`          | Dot size and spacing across the grain field.                   |
| `accent`  | `green` | `green`, `blue`, `violet` | Accent token family used to color the dots and luminance wash. |

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="grain-field"
  data-composition-src="compositions/components/grain-field.html"
  data-variable-values='{"density":"fine","accent":"green"}'
></div>
```

## Source

<Accordion title={`grain-field.html`}>
  ```html theme={null}
  <!doctype html>
  <!--
    grain-field: HyperFrames video primitive (backgrounds / ambient)

    Concept: a fixed repeated dot field drifts slowly across a deep,
    accent-tinted luminance wash. The dots stay intentionally legible at
    gallery-card size so the texture reads as a designed surface.

    Variables:
      - density (fine | coarse, default fine): controls dot size and spacing.
      - accent (green | blue | violet, default green): colors the dots and wash.

    Envelope: IN = 0, HOLD = the full elastic duration, OUT = 0. A longer mount
    stretches only the ambient drift cycle.

    Loop invariant: the phase completes one full sine cycle during HOLD. The
    endpoint is normalized to phase zero before rendering, so t=0 and
    t=duration have exactly the same transform.

    Sound: none.

    Mount contract: the runtime clones only this template. #root fills the host
    box, establishes the container query basis, has no data-width or data-height,
    and registers one paused timeline under the hardcoded grain-field id.
  -->
  <html
    lang="en"
    data-composition-id="grain-field"
    data-composition-duration="4"
    data-composition-variables='[
      { "id": "density", "type": "enum", "role": "style", "label": "Density", "description": "Dot size and spacing across the grain field.", "default": "fine", "options": [{ "value": "fine", "label": "Fine" }, { "value": "coarse", "label": "Coarse" }] },
      { "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Accent token family used to color the dots and luminance wash.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] }
    ]'
  >
    <head>
      <meta charset="UTF-8" />
      <title>Grain Field</title>
    </head>
    <body>
      <template>
        <div id="root" data-composition-id="grain-field" data-duration="4" data-fps="30">
          <style>
            *,
            *::before,
            *::after {
              box-sizing: border-box;
            }

            #root {
              position: absolute;
              inset: 0;
              overflow: hidden;
              container-type: size;
              isolation: isolate;
              pointer-events: none;
            }

            .gf-clip,
            .gf-base,
            .gf-field {
              position: absolute;
            }

            .gf-clip,
            .gf-base {
              inset: 0;
            }

            .gf-clip {
              overflow: hidden;
            }

            .gf-base {
              background:
                radial-gradient(
                  ellipse at 28% 20%,
                  color-mix(in srgb, var(--gf-color) 18%, transparent) 0%,
                  transparent 56%
                ),
                linear-gradient(
                  145deg,
                  color-mix(in srgb, var(--gf-base) 90%, var(--gf-color)) 0%,
                  var(--gf-base) 72%
                );
            }

            .gf-field {
              inset: -8cqw;
              background-image: radial-gradient(
                circle,
                color-mix(in srgb, var(--gf-color) 70%, white) 0 var(--gf-dot),
                transparent calc(var(--gf-dot) + 0.12cqmin)
              );
              background-position: 0 0;
              background-size: var(--gf-cell) var(--gf-cell);
              opacity: 0.82;
              will-change: transform;
            }
          </style>

          <div
            id="grain-field-clip"
            class="gf-clip clip"
            data-start="0"
            data-duration="4"
            data-track-index="0"
          >
            <div class="gf-base"></div>
            <div class="gf-field"></div>
          </div>

          <script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
          <script>
            (function () {
              "use strict";

              var root = document.getElementById("root");
              var field = root.querySelector(".gf-field");
              var vars =
                window.__hyperframes && window.__hyperframes.getVariables
                  ? window.__hyperframes.getVariables()
                  : {};

              // Invalid enum overrides return to their declared defaults.
              var accentTokens = {
                green: "var(--brand, #34d399)",
                blue: "var(--accent, #38bdf8)",
                violet: "var(--accent-2, #a78bfa)",
              };
              var densityStyles = {
                fine: { cell: "3.2cqmin", dot: "0.48cqmin" },
                coarse: { cell: "5.8cqmin", dot: "0.86cqmin" },
              };
              var accent = Object.prototype.hasOwnProperty.call(accentTokens, vars.accent)
                ? vars.accent
                : "green";
              var density = vars.density === "coarse" ? "coarse" : "fine";

              root.style.setProperty("--gf-color", accentTokens[accent]);
              root.style.setProperty("--gf-base", "var(--bg, #080a10)");
              root.style.setProperty("--gf-cell", densityStyles[density].cell);
              root.style.setProperty("--gf-dot", densityStyles[density].dot);

              var TAU = Math.PI * 2;
              var duration = Math.max(0.001, parseFloat(root.dataset.duration || "4"));
              var state = { phase: 0 };

              function renderPose() {
                var phase = state.phase === TAU ? 0 : state.phase;
                var drift = Math.sin(phase);
                gsap.set(field, { x: drift * 2.8 + "cqw", y: drift * 2.2 + "cqh" });
              }

              var tl = gsap.timeline({ paused: true });

              // HOLD: uniform phase travel becomes a smooth sine drift. One full
              // cycle restores the exact starting pose at the duration boundary.
              tl.to(state, { phase: TAU, duration: duration, ease: "none", onUpdate: renderPose }, 0);

              renderPose();
              tl.seek(0);

              window.__timelines = window.__timelines || {};
              window.__timelines["grain-field"] = tl;
            })();
          </script>
        </div>
      </template>
    </body>
  </html>
  ```
</Accordion>

Tagged `motion-primitive` `background` `grain` `dots` `texture` `ambient` `loopable`.

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

- [Soft Blob Touch](/catalog/components/soft-blob-touch.md)
- [Grain Overlay](/catalog/components/grain-overlay.md)
- [Halftone Field](/catalog/blocks/halftone-field.md)
