> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes-canary-calibration-notes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Reuse a design with variables

> Change approved text, colors, media, and choices without rebuilding the composition.

Variables expose the parts of a composition that are meant to change. One
customer card can accept a different name, logo, color, and plan while keeping
the same layout and motion.

Use a variable when the design should remain stable across versions. Make a
normal source edit when the structure itself needs to change.

<div className="not-prose my-7 grid grid-cols-2 gap-3">
  <div className="overflow-hidden rounded-xl border border-zinc-200 bg-zinc-950 dark:border-zinc-800">
    <video className="aspect-video w-full object-cover" src="https://static.heygen.ai/hyperframes-oss/docs/images/prompting/validate-variables-default.mp4#t=0.1" autoPlay muted loop playsInline preload="metadata" />

    <div className="px-3 py-2 text-sm text-zinc-600 dark:text-zinc-400">Default values</div>
  </div>

  <div className="overflow-hidden rounded-xl border border-zinc-200 bg-zinc-950 dark:border-zinc-800">
    <video className="aspect-video w-full object-cover" src="https://static.heygen.ai/hyperframes-oss/docs/images/prompting/validate-variables-variant.mp4#t=0.1" autoPlay muted loop playsInline preload="metadata" />

    <div className="px-3 py-2 text-sm text-zinc-600 dark:text-zinc-400">
      The same design with different values
    </div>
  </div>
</div>

## Use variables in Studio

Studio can create and bind variables, preview overrides, and copy the reviewed
values into a render command. Follow [Use variables and templates](/studio/variables)
for that complete workflow.

## Advanced: declare the approved inputs

Variables live on the composition declaration:

```html compositions/card.html theme={null}
<html
  data-composition-variables='[
  {"id":"title","type":"string","label":"Title","default":"Pro"},
  {"id":"accent","type":"color","label":"Accent color","default":"#6c5ce7"},
  {"id":"logo","type":"string","label":"Logo","default":"assets/logo.svg"}
]'
></html>
```

Supported declared types are:

| Type      | Good for                               |
| --------- | -------------------------------------- |
| `string`  | Text or a media path                   |
| `number`  | Counts, positions, sizes, or strengths |
| `color`   | Approved color choices                 |
| `boolean` | On or off                              |
| `enum`    | One value from an approved list        |
| `font`    | A font-family choice                   |
| `image`   | An image path or image value           |

The type lets Studio show the right control and lets rendering catch invalid
values.

## Bind common values without a script

Use direct bindings for the normal cases:

```html theme={null}
<h1 data-var-text="title">Pro</h1>

<img data-var-src="logo" src="assets/logo.svg" alt="" />

<style>
  .card-title {
    color: var(--accent);
  }
</style>
```

* `data-var-text` replaces the element’s own text.
* `data-var-src` replaces an image, video, audio, or source URL.
* Scalar variables are available as CSS custom properties such as
  `var(--accent)`.

Use `window.__hyperframes.getVariables()` only when the result needs conditions,
loops, or derived values:

```js theme={null}
const { featured = false } = window.__hyperframes.getVariables();
document.querySelector(".badge").hidden = !featured;
```

## Give each nested composition different values

A parent can reuse the same composition several times:

```html index.html theme={null}
<div
  data-composition-id="card-pro"
  data-composition-src="compositions/card.html"
  data-start="0"
  data-duration="3"
  data-track-index="1"
data-variable-values='{"title":"Pro","accent":"#ff4d4f"}'
></div>

<div
  data-composition-id="card-enterprise"
  data-composition-src="compositions/card.html"
  data-start="card-pro"
  data-duration="3"
  data-track-index="1"
data-variable-values='{"title":"Enterprise","accent":"#22c55e"}'
></div>
```

Both instances keep the same source and receive different content.

## Advanced: render a version from data

Override top-level values from the CLI:

```bash theme={null}
npx hyperframes render \
  --variables '{"title":"Enterprise","accent":"#22c55e"}' \
  --strict-variables \
  --output enterprise.mp4
```

Use `--variables-file` for a JSON file and `--batch` when the same composition
must render once per data row. The [CLI reference](/packages/cli) covers batch
output, validation, and automation.

### Batch renders

Put one variable object per row in a JSON array, then use placeholders from the
row to name each output:

```json rows.json theme={null}
[
  { "name": "acme", "title": "Acme Pro" },
  { "name": "northstar", "title": "Northstar Pro" }
]
```

```bash theme={null}
npx hyperframes render \
  --batch rows.json \
  --strict-variables \
  --output "renders/{name}.mp4"
```

Start with the default single-row concurrency. Increase `--batch-concurrency`
only after one real render is stable and the machine has enough memory for
several renders at once.

## What can't be a variable

Variables change content inside a composition. They do not change:

* the composition viewport;
* the root composition’s total render duration;
* frame rate;
* output format, codec, or quality;
* a parent or sibling composition unless values are passed to it explicitly.

Those choices are read from source or render settings before composition logic
runs.

## Check the contract

Run:

```bash theme={null}
npx hyperframes lint
```

The linter catches malformed declarations, missing fields, wrong default types,
and invalid enum choices. `--strict-variables` turns undeclared or mistyped
render values into errors.

Continue to [Compositions](/concepts/compositions) for nesting or the
[HTML schema](/reference/html-schema) for the complete attribute contract.
