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

# Shared Axis Z

> Scale-based shared-axis transition for focus shifts and context depth.

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

## Install

<InstallCommand command="npx hyperframes add shared-axis-z" />

That writes one file: `compositions/components/shared-axis-z.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                                                                                                       |
| ----------- | ---------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `direction` | `in`       | `in`, `out`                   | Which way the words travel along the z axis: in swells up from small, out settles down from large.                 |
| `depth`     | `standard` | `shallow`, `standard`, `deep` | Scales how far the words start from their final size, so the push covers a shorter or longer run in the same time. |
| `tone`      | `ink`      | `ink`, `paper`, `accent`      | Word colour: ink for light frames, paper for dark ones, accent rides --brand.                                      |

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="shared-axis-z"
  data-composition-src="compositions/components/shared-axis-z.html"
  data-variable-values='{"direction":"in","depth":"standard","tone":"ink"}'
></div>
```

## Source

<Accordion title={`shared-axis-z.html`}>
  ```html theme={null}
  <!--
    Shared Axis Z - remocn typography primitive for HyperFrames.

    Paste the markup, CSS and script into a composition. Drive the timeline
    integration from a paused GSAP timeline so renders remain deterministic.

    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 above consumes. The timeline recipe below is untouched by them: it
    keeps driving one scale from 0.72 to 1, and these decide how far from the
    final size that start really sits. At rest the scale is 1, so every setting
    lands on the same final frame.

      - direction (in | out, default in): which way the words travel along the
        z axis. in swells up from a smaller start, out settles down from a
        larger one.
      - depth (shallow | standard | deep, default standard): scales the gap
        between the start size and the final size. shallow covers half the run,
        deep nearly double, in the same time.
      - tone (ink | paper | accent, default ink): word colour. ink is near-black
        for light frames, paper near-white for dark ones, accent rides --brand.

    On every default the result is identical to the original: words swell from
    0.72 to full size in near-black.
  -->

  <div
    class="hf-remocn-shared-axis-z"
    data-composition-variables='[
      { "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Which way the words travel along the z axis: in swells up from small, out settles down from large.", "default": "in", "options": [{ "value": "in", "label": "In" }, { "value": "out", "label": "Out" }] },
      { "id": "depth", "type": "enum", "role": "motion", "label": "Depth", "description": "Scales how far the words start from their final size, so the push covers a shorter or longer run in the same time.", "default": "standard", "options": [{ "value": "shallow", "label": "Shallow" }, { "value": "standard", "label": "Standard" }, { "value": "deep", "label": "Deep" }] },
      { "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Word colour: ink for light frames, paper for dark ones, accent rides --brand.", "default": "ink", "options": [{ "value": "ink", "label": "Ink" }, { "value": "paper", "label": "Paper" }, { "value": "accent", "label": "Accent" }] }
    ]'
  >
    <span>Zoom</span><span>context</span>
  </div>

  <style>
    .hf-remocn-shared-axis-z {
      color: var(--hf-word-color, #18181b);
      font-family: Inter, system-ui, sans-serif;
      font-weight: 900;
      letter-spacing: -0.04em;
    }
    .hf-remocn-shared-axis-z {
      display: inline-flex;
      gap: 12px;
      font-size: 56px;
      line-height: 1;
    }
    .hf-remocn-shared-axis-z span {
      display: inline-block;
      transform: translate(var(--hf-word-x, 0px), var(--hf-word-y, 0px))
        scale(calc(1 + (var(--hf-word-scale, 1) - 1) * var(--hf-word-depth, 1)));
      filter: blur(var(--hf-word-blur, 0px));
      will-change: transform, filter, opacity;
    }
  </style>

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

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

      // Unrecognised overrides return to their declared defaults.
      var signs = { in: 1, out: -1 };
      var reaches = { shallow: 0.5, standard: 1, deep: 1.85 };
      var tones = {
        ink: "#18181b",
        paper: "#fafafa",
        accent: "var(--brand, #34d399)",
      };

      function pick(table, value, fallback) {
        return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
      }

      var sign = signs[pick(signs, vars.direction, "in")];
      var reach = reaches[pick(reaches, vars.depth, "standard")];
      var tone = tones[pick(tones, vars.tone, "ink")];

      var roots = document.querySelectorAll(".hf-remocn-shared-axis-z");
      for (var i = 0; i < roots.length; i += 1) {
        roots[i].style.setProperty("--hf-word-depth", String(sign * reach));
        roots[i].style.setProperty("--hf-word-color", tone);
      }
    })();
  </script>

  <!--
    Timeline integration:
    tl.fromTo('.hf-remocn-shared-axis-z span', { opacity: 0, '--hf-word-scale': 0.72 }, { opacity: 1, '--hf-word-scale': 1, duration: 0.34, stagger: 0.06, ease: 'back.out(1.8)' }, startTime);
  -->
  ```
</Accordion>

## Usage

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

Tagged `motion-primitive` `remocn-port` `typography`.

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

- [Shared Axis Y](/catalog/components/shared-axis-y.md)
- [Variable Axis Type](/catalog/components/variable-axis-type.md)
- [Staggered Fade Up](/catalog/components/staggered-fade-up.md)
