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

# Menu Morph

> A transitions.dev-inspired hamburger and plus-menu morph primitive for compact action menus

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

## Install

<InstallCommand command="npx hyperframes add menu-morph" />

That writes one file: `compositions/components/menu-morph.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                                                                   |
| --------- | -------------------- | -------------------------------- | ------------------------------------------------------------------------------ |
| `actions` | `Text, Image, Audio` | string                           | Comma separated labels for the pills that fan out under the button. Up to six. |
| `tone`    | `ink`                | `ink`, `green`, `blue`, `violet` | Colour of the round button behind the white bars.                              |
| `size`    | `68`                 | 52px to 112px, step 4px          | Diameter of the round button in pixels. The bars scale with it.                |

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="menu-morph"
  data-composition-src="compositions/components/menu-morph.html"
  data-variable-values='{"actions":"Text, Image, Audio","tone":"ink","size":68}'
></div>
```

## Source

<Accordion title={`menu-morph.html`}>
  ```html theme={null}
  <!--
    Menu Morph - transitions.dev-inspired primitive for HyperFrames.

    Paste the markup, CSS and script into a composition. Use the timeline
    integration note at the bottom as the starting point for deterministic GSAP
    animation.

    Variables. The script reads each one, falls back to the declared default on
    anything missing or invalid, and writes the result as a custom property the
    CSS consumes (or, for the actions, as the pills themselves). The timeline
    recipe below is untouched by them: it still pops the button, crosses the two
    outer bars and staggers whatever pills are present.

      - actions (text, default Text, Image, Audio): comma separated labels for
        the pills that fan out under the button, up to six. The stagger picks up
        the new count.
      - tone (ink | green | blue | violet, default ink): colour of the round
        button behind the white bars. ink is a literal near-black; the other three
        ride the composition's own brand, accent and accent-2 tokens and fall back
        to that same ink when the composition declares none.
      - size (52 to 112 px, default 68): diameter of the round button. The bar
        width is a fixed fraction of it, so the whole glyph scales together.

    On every default the result is identical to the original: a 68px near-black
    button with 24px bars over three pills.
  -->

  <div
    class="hf-transition-menu-morph"
    data-composition-variables='[
      { "id": "actions", "type": "string", "role": "content", "label": "Actions", "description": "Comma separated labels for the pills that fan out under the button. Up to six.", "default": "Text, Image, Audio" },
      { "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Colour of the round button behind the white bars.", "default": "ink", "options": [{ "value": "ink", "label": "Ink" }, { "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
      { "id": "size", "type": "number", "role": "layout", "label": "Button size", "description": "Diameter of the round button in pixels. The bars scale with it.", "default": 68, "min": 52, "max": 112, "step": 4, "unit": "px" }
    ]'
  >
    <button class="hf-transition-menu-button" type="button" aria-label="Menu">
      <span></span><span></span><span></span>
    </button>
    <div class="hf-transition-menu-actions">
      <div>Text</div>
      <div>Image</div>
      <div>Audio</div>
    </div>
  </div>

  <style>
    .hf-transition-menu-morph {
      position: relative;
      display: grid;
      place-items: center;
      width: 360px;
      height: 220px;
      font-family: Inter, system-ui, sans-serif;
    }
    .hf-transition-menu-button {
      z-index: 2;
      display: grid;
      place-items: center;
      gap: 5px;
      width: var(--hf-menu-size, 68px);
      height: var(--hf-menu-size, 68px);
      border: 0;
      border-radius: 999px;
      background: var(--hf-menu-bg, #18181b);
      box-shadow: 0 22px 58px rgba(0, 0, 0, 0.22);
    }
    .hf-transition-menu-button span {
      width: calc(var(--hf-menu-size, 68px) * 6 / 17);
      height: 3px;
      border-radius: 999px;
      background: #ffffff;
      transform-origin: center;
    }
    .hf-transition-menu-actions {
      position: absolute;
      display: flex;
      gap: 10px;
      bottom: 20px;
    }
    .hf-transition-menu-actions div {
      padding: 9px 13px;
      border-radius: 999px;
      background: #ffffff;
      color: #18181b;
      font-size: 13px;
      font-weight: 850;
      box-shadow: 0 14px 34px rgba(0, 0, 0, 0.12);
    }
  </style>

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

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

      // Anything missing or invalid returns to its declared default.
      // The button is the one accent-carrying element here, so the three
      // chromatic options ride the composition's own tokens and fall back to ink.
      var tones = {
        ink: "#18181b",
        green: "var(--brand, #18181b)",
        blue: "var(--accent, #18181b)",
        violet: "var(--accent-2, #18181b)",
      };

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

      var labels = [];
      if (typeof vars.actions === "string") {
        var parts = vars.actions.split(",");
        for (var p = 0; p < parts.length && labels.length < 6; p += 1) {
          var label = parts[p].trim();
          if (label) {
            labels.push(label);
          }
        }
      }
      if (!labels.length) {
        labels = ["Text", "Image", "Audio"];
      }

      var size =
        typeof vars.size === "number" || typeof vars.size === "string" ? Number(vars.size) : NaN;
      size = isFinite(size) && size > 0 ? Math.min(112, Math.max(52, size)) : 68;

      var tone = tones[pick(tones, vars.tone, "ink")];

      var roots = document.querySelectorAll(".hf-transition-menu-morph");
      for (var i = 0; i < roots.length; i += 1) {
        roots[i].style.setProperty("--hf-menu-size", size + "px");
        roots[i].style.setProperty("--hf-menu-bg", tone);
        var row = roots[i].querySelector(".hf-transition-menu-actions");
        if (!row) {
          continue;
        }
        while (row.firstChild) {
          row.removeChild(row.firstChild);
        }
        for (var j = 0; j < labels.length; j += 1) {
          var pill = document.createElement("div");
          pill.textContent = labels[j];
          row.appendChild(pill);
        }
      }
    })();
  </script>

  <!--
    Timeline integration:
    tl.fromTo('.hf-transition-menu-button', { scale: 0.72, opacity: 0 }, { scale: 1, opacity: 1, duration: 0.34, ease: 'back.out(1.8)' }, 0.3);
    tl.to('.hf-transition-menu-button span:nth-child(1)', { y: 8, rotation: 45, duration: 0.24, ease: 'power2.inOut' }, 0.78);
    tl.to('.hf-transition-menu-button span:nth-child(2)', { opacity: 0, duration: 0.18, ease: 'power1.out' }, 0.78);
    tl.to('.hf-transition-menu-button span:nth-child(3)', { y: -8, rotation: -45, duration: 0.24, ease: 'power2.inOut' }, 0.78);
    tl.fromTo('.hf-transition-menu-actions div', { y: 28, opacity: 0, scale: 0.86 }, { y: 0, opacity: 1, scale: 1, duration: 0.26, stagger: 0.06, ease: 'back.out(1.6)' }, 0.96);
  -->
  ```
</Accordion>

## Usage

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

Tagged `video-primitive` `transition-primitive` `transitions-dev-port` `menu` `morph`.

## 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 Glass Context Menu](/catalog/blocks/liquid-glass-context-menu.md)
- [Morph Text](/catalog/components/morph-text.md)
- [Morph Swap](/catalog/components/morph-swap.md)
