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

# Avatar Group Hover

> A distance-falloff avatar group lift with bouncy hover return

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

## Install

<InstallCommand command="npx hyperframes add avatar-group-hover" />

That writes one file: `compositions/components/avatar-group-hover.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                                                                       |
| --------- | ---------- | ---------------------------- | ---------------------------------------------------------------------------------- |
| `size`    | `standard` | `small`, `standard`, `large` | Avatar diameter, with the initials scaling alongside it.                           |
| `overlap` | `standard` | `tight`, `standard`, `loose` | How far each avatar tucks under the one before it, as a share of its own diameter. |
| `accent`  | `blue`     | `blue`, `violet`, `green`    | Colour the avatar gradient resolves into.                                          |

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="avatar-group-hover"
  data-composition-src="compositions/components/avatar-group-hover.html"
  data-variable-values='{"size":"standard","overlap":"standard","accent":"blue"}'
></div>
```

## Source

<Accordion title={`avatar-group-hover.html`}>
  ```html theme={null}
  <!--
    Avatar Group Hover - transitions.dev-inspired primitive for HyperFrames.

    Paste the markup and CSS 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 unrecognised, and writes the result as a custom property
    the CSS consumes. The timeline recipe below is untouched by them: it still
    drives one lift offset, and these decide what it lifts.

      - size (small | standard | large, default standard): avatar diameter,
        42px, 54px or 70px. The initials scale with it.
      - overlap (tight | standard | loose, default standard): how far each
        avatar tucks under the one before it, as a share of its own diameter:
        half, a third, or barely an eighth.
      - accent (blue | violet | green, default blue): the colour the avatar
        gradient resolves into out of the shared near-black.

    On every default the result is identical to the original: 54px avatars
    overlapping by 18px in the blue gradient.
  -->

  <div
    class="hf-transition-avatar-group-hover"
    data-composition-variables='[
      { "id": "size", "type": "enum", "role": "style", "label": "Size", "description": "Avatar diameter, with the initials scaling alongside it.", "default": "standard", "options": [{ "value": "small", "label": "Small" }, { "value": "standard", "label": "Standard" }, { "value": "large", "label": "Large" }] },
      { "id": "overlap", "type": "enum", "role": "style", "label": "Overlap", "description": "How far each avatar tucks under the one before it, as a share of its own diameter.", "default": "standard", "options": [{ "value": "tight", "label": "Tight" }, { "value": "standard", "label": "Standard" }, { "value": "loose", "label": "Loose" }] },
      { "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Colour the avatar gradient resolves into.", "default": "blue", "options": [{ "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }, { "value": "green", "label": "Green" }] }
    ]'
  >
    <span>A</span><span>B</span><span>C</span><span>D</span>
  </div>

  <style>
    .hf-transition-avatar-group-hover {
      display: inline-flex;
      align-items: center;
      padding-left: var(--hf-avatar-overlap, 18px);
      font-family: Inter, system-ui, sans-serif;
    }
    .hf-transition-avatar-group-hover span {
      display: grid;
      place-items: center;
      width: var(--hf-avatar-size, 54px);
      height: var(--hf-avatar-size, 54px);
      margin-left: calc(-1 * var(--hf-avatar-overlap, 18px));
      border: 3px solid #fff;
      border-radius: 999px;
      background: linear-gradient(135deg, #111827, var(--hf-avatar-accent, #0ea5e9));
      color: #fff;
      font-size: var(--hf-avatar-font, 1em);
      font-weight: 900;
      box-shadow: 0 12px 30px rgba(24, 24, 27, 0.18);
      transform: translateY(var(--hf-avatar-y, 0px));
    }
  </style>

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

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

      // Unrecognised overrides return to their declared defaults.
      var sizes = { small: 42, standard: 54, large: 70 };
      var fonts = { small: "0.8em", standard: "1em", large: "1.3em" };
      // Overlap is a share of the diameter, so the two knobs stay independent.
      var overlaps = { tight: 0.5, standard: 1 / 3, loose: 0.12 };
      var accents = { blue: "#0ea5e9", violet: "#a78bfa", green: "#34d399" };

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

      var sizeName = pick(sizes, vars.size, "standard");
      var overlapName = pick(overlaps, vars.overlap, "standard");
      var accent = accents[pick(accents, vars.accent, "blue")];
      var diameter = sizes[sizeName];
      var overlap = Math.round(diameter * overlaps[overlapName]);

      var roots = document.querySelectorAll(".hf-transition-avatar-group-hover");
      for (var i = 0; i < roots.length; i += 1) {
        var style = roots[i].style;
        style.setProperty("--hf-avatar-size", diameter + "px");
        style.setProperty("--hf-avatar-font", fonts[sizeName]);
        style.setProperty("--hf-avatar-overlap", overlap + "px");
        style.setProperty("--hf-avatar-accent", accent);
      }
    })();
  </script>

  <!--
    Timeline integration:
    tl.to('.hf-transition-avatar-group-hover span', { '--hf-avatar-y': '-18px', duration: 0.28, stagger: { each: 0.035, from: 'center' }, ease: 'back.out(1.8)' }, startTime); tl.to('.hf-transition-avatar-group-hover span', { '--hf-avatar-y': '0px', duration: 0.42, stagger: { each: 0.035, from: 'center' }, ease: 'bounce.out' }, startTime + 0.36);
  -->
  ```
</Accordion>

## Usage

Open `compositions/components/avatar-group-hover.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` `avatar` `hover`.

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

- [Avatar Cloud](/catalog/components/avatar-cloud.md)
- [Add an avatar presenter](/guides/avatar-presenter.md)
- [Tilt Card](/catalog/components/tilt-card.md)
