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

# Bottom Up Letters

> Splits text into letters and reveals each glyph from below with deterministic staggered timing

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

## Install

<InstallCommand command="npx hyperframes add bottom-up-letters" />

That writes one file: `compositions/components/bottom-up-letters.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                                                                                  |
| ----------- | ---------- | -------------------------- | --------------------------------------------------------------------------------------------- |
| `unit`      | `letter`   | `letter`, `word`           | What each animated span holds. Letter staggers glyph by glyph, word keeps whole words intact. |
| `direction` | `up`       | `up`, `down`               | Where each span starts. Up starts below the baseline and rises, down starts above and drops.  |
| `travel`    | `standard` | `close`, `standard`, `far` | How far each span starts from its resting position, from 0.45em to 1.5em.                     |

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="bottom-up-letters"
  data-composition-src="compositions/components/bottom-up-letters.html"
  data-variable-values='{"unit":"letter","direction":"up","travel":"standard"}'
></div>
```

## Source

<Accordion title={`bottom-up-letters.html`}>
  ```html theme={null}
  <!--
    Bottom Up Letters - deterministic text splitter.

    Add class="hf-bottom-up-letters" to a plain text element. This script wraps
    each character in a span so your paused GSAP timeline can stagger the reveal.

    Variables. This fragment has no markup of its own, so the declaration rides
    the <style> element below; the runtime collects every element carrying
    data-composition-variables, not just the document root. The script reads each
    value, falls back to the declared default on anything missing or
    unrecognised, and either changes how the text is split or writes a custom
    property the CSS consumes. The timeline recipe below is untouched by them: it
    still tweens opacity and y back to rest, and these decide what a single
    stagger step covers and where rest is travelled from.

      - unit (letter | word, default letter): what each animated span holds.
        letter staggers glyph by glyph; word keeps whole words intact, so a long
        line reads instead of shimmers.
      - direction (up | down, default up): where the spans start. up starts
        below the baseline and rises into place, down starts above and drops.
      - travel (close | standard | far, default standard): how far each span
        starts from rest, from 0.45em through 0.85em to 1.5em.

    On every default the result is identical to the original: one span per
    character, each starting 0.85em below the baseline.
  -->

  <style
    data-composition-variables='[
    { "id": "unit", "type": "enum", "role": "content", "label": "Split unit", "description": "What each animated span holds. Letter staggers glyph by glyph, word keeps whole words intact.", "default": "letter", "options": [{ "value": "letter", "label": "Letter" }, { "value": "word", "label": "Word" }] },
    { "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Where each span starts. Up starts below the baseline and rises, down starts above and drops.", "default": "up", "options": [{ "value": "up", "label": "Up" }, { "value": "down", "label": "Down" }] },
    { "id": "travel", "type": "enum", "role": "motion", "label": "Travel", "description": "How far each span starts from its resting position, from 0.45em to 1.5em.", "default": "standard", "options": [{ "value": "close", "label": "Close" }, { "value": "standard", "label": "Standard" }, { "value": "far", "label": "Far" }] }
  ]'
  >
    .hf-bottom-up-letters {
      display: inline-block;
    }
    .hf-bottom-up-letters-char {
      display: inline-block;
      opacity: 0;
      transform: translate3d(
        0,
        calc(var(--hf-letters-travel, 0.85em) * var(--hf-letters-direction, 1)),
        0
      );
      will-change: transform, opacity;
    }
  </style>

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

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

      // Unrecognised overrides return to their declared defaults.
      function pick(table, value, fallback) {
        return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
      }

      var travels = { close: "0.45em", standard: "0.85em", far: "1.5em" };
      var directions = { up: "1", down: "-1" };
      var units = { letter: true, word: true };

      var travel = travels[pick(travels, vars.travel, "standard")];
      var direction = directions[pick(directions, vars.direction, "up")];
      var unit = pick(units, vars.unit, "letter");

      document.querySelectorAll(".hf-bottom-up-letters").forEach((el) => {
        el.style.setProperty("--hf-letters-travel", travel);
        el.style.setProperty("--hf-letters-direction", direction);
        if (el.dataset.hfLettersReady === "1") return;
        const text = el.textContent || "";
        el.textContent = "";
        const parts = unit === "word" ? text.split(/(\s+)/) : Array.from(text);
        for (const part of parts) {
          if (part === "") continue;
          if (unit === "word" && /^\s+$/.test(part)) {
            el.appendChild(document.createTextNode(part));
            continue;
          }
          const span = document.createElement("span");
          span.className = "hf-bottom-up-letters-char";
          span.textContent = part === " " ? "\u00a0" : part;
          el.appendChild(span);
        }
        el.dataset.hfLettersReady = "1";
      });
    })();
  </script>

  <!--
    Timeline integration:

    tl.to(".hf-bottom-up-letters-char", {
      opacity: 1,
      y: 0,
      duration: 0.48,
      ease: "back.out(1.7)",
      stagger: 0.025,
    }, startTime);
  -->
  ```
</Accordion>

## Usage

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

Tagged `motion-primitive` `text` `letters` `reveal`.

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

- [Staggered Fade Up](/catalog/components/staggered-fade-up.md)
- [Count Up](/catalog/components/count-up.md)
- [Line Swap](/catalog/components/line-swap.md)
