Files
hyperframes/docs/catalog/components/headline-slam.mdx
T
Ular Kimsanov a06fdfe26e docs(catalog): put each item page's title, description and Docs text in the server HTML (#6711)
* docs(catalog): put each item page's title, description and Docs text in the server HTML

Mintlify renders snippet components in the browser only, so everything inside
CatalogDetail (title, standfirst, the Docs tab) was missing from the HTML search
engines read: 448 catalog pages served Googlebot no body text. The generator now
writes the H1 and standfirst as page markup above the component and the Docs tab
as page markup after it, shown with that tab (docs/custom.css). The component no
longer draws its own title. Pages patched structurally only; registry drift on 14
pages is left for a regeneration of its own.

* docs(catalog): keep the title's top spacing the component gave it

* fix(docs): catalog titles and descriptions keep markdown markers literal

MDX reads text inside the static <h1> and <p> as inline markdown, so @_blue_sweater_
rendered as italic blue_sweater. mdxText now writes backslash, backtick, * _ [ ] ~ as
character references too, with a unit test; the four affected pages are re-escaped.
2026-10-30 15:48:25 +00:00

324 lines
12 KiB
Plaintext

---
title: "Headline Slam"
description: "A heavyweight headline scales down into frame, lands with a deterministic three-frame shake, holds with subtle drift, and whips upward on exit."
mode: "frame"
---
import { CatalogDetail, CatalogSlot } from "/snippets/catalog-detail.jsx";
import { InstallCommand } from "/snippets/install-command.jsx";
<div className="hf-ve-static-head not-prose">
<h1>Headline Slam</h1>
<p>A heavyweight headline scales down into frame, lands with a deterministic three-frame shake, holds with subtle drift, and whips upward on exit.</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/headline-slam.json"
compositionId="headline-slam"
compositionSrc="compositions/components/headline-slam.html"
title="Headline Slam"
variables={[{"id":"text","type":"string","role":"content","label":"Headline","description":"Text displayed as the headline.","default":"Ship it today"},{"id":"accent_word_index","type":"number","role":"content","label":"Accent word index","description":"Zero-based word index to color. Out of range leaves the headline unaccented.","default":1,"step":1},{"id":"accent","type":"enum","role":"style","label":"Accent","description":"Color applied to the selected word.","default":"green","options":[{"value":"green","label":"Green"},{"value":"blue","label":"Blue"},{"value":"violet","label":"Violet"}]},{"id":"shadow","type":"boolean","role":"style","label":"Shadow","description":"Drop shadow cast under the headline. On by default; set false for a flat matte look.","default":true}]}
meta={{"category":"Typography & Text","badge":"Stable","codeLines":237}}
attribution={{"path":"registry/components/headline-slam","tags":["motion-primitive","typography","headline","slam","impact","exit"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/headline-slam/headline-slam.html"
>
<CatalogSlot slot="code">
```html headline-slam.html
<!doctype html>
<!--
headline-slam: HyperFrames video primitive
One headline scales down from 1.6 to rest with expo.out weight. Its landing
drives a deterministic three-frame stage shake, followed by a quiet drift
and a fast upward exit.
Variables:
text: headline copy
accent_word_index: zero-based word index to color, out of range colors none
accent: green, blue, or violet accent color
shadow: drop shadow under the headline, on by default
Envelope, fixed IN and OUT with elastic HOLD:
IN_BASE = 0.72s, headline slam and three-frame impact shake
HOLD = max(0, D - IN - OUT), one subtle drift cycle
OUT_BASE = 0.46s, headline whips upward out of frame
If D is shorter than IN_BASE + OUT_BASE, IN and OUT compress together.
The timeline is never time-scaled.
Mount contract: the runtime clones only this template. #root fills the host
box, establishes the container query basis, and has no data-width or
data-height. One paused timeline registers under the literal headline-slam
key.
-->
<html
lang="en"
data-composition-id="headline-slam"
data-composition-duration="3.5"
data-composition-variables='[
{ "id": "text", "type": "string", "role": "content", "label": "Headline", "description": "Text displayed as the headline.", "default": "Ship it today" },
{ "id": "accent_word_index", "type": "number", "role": "content", "label": "Accent word index", "description": "Zero-based word index to color. Out of range leaves the headline unaccented.", "default": 1, "step": 1 },
{ "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Color applied to the selected word.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
{ "id": "shadow", "type": "boolean", "role": "style", "label": "Shadow", "description": "Drop shadow cast under the headline. On by default; set false for a flat matte look.", "default": true }
]'
>
<head>
<meta charset="UTF-8" />
<title>Headline Slam</title>
</head>
<body>
<template>
<div id="root" data-composition-id="headline-slam" data-duration="3.5" data-fps="30">
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}
#root {
position: absolute;
inset: 0;
overflow: hidden;
container-type: size;
isolation: isolate;
color: var(--fg, #f8fafc);
font-family: var(--font-display, Inter, system-ui, sans-serif);
pointer-events: none;
}
.hs-clip,
.hs-stage {
position: absolute;
inset: 0;
width: 100cqw;
height: 100cqh;
}
.hs-clip {
overflow: hidden;
}
.hs-stage {
display: grid;
place-items: center;
will-change: transform;
}
.hs-headline {
display: flex;
align-items: center;
justify-content: center;
gap: 2cqw;
width: 90cqw;
min-height: 22cqh;
color: var(--fg, #f8fafc);
font-size: var(--hs-font-size, 10.5cqw);
font-weight: 900;
line-height: 0.88;
letter-spacing: -0.5cqw;
text-align: center;
white-space: nowrap;
transform-origin: 50% 50%;
will-change: transform, opacity;
}
/* Shadow is on by default; the shadow variable opts out of it. */
.hs-headline.hs-shadow {
text-shadow: 0 1.2cqh 4.5cqh color-mix(in srgb, #000 52%, transparent);
}
.hs-word {
display: inline-block;
}
.hs-word-accent {
color: var(--hs-accent, #71f5a7);
}
</style>
<div
id="headline-slam-clip"
class="hs-clip clip"
data-start="0"
data-duration="3.5"
data-track-index="0"
>
<div class="hs-stage">
<div class="hs-headline" role="heading" aria-level="1"></div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
<script>
(function () {
"use strict";
var root = document.getElementById("root");
var stage = root.querySelector(".hs-stage");
var headline = root.querySelector(".hs-headline");
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
var text = vars.text == null ? "Ship it today" : String(vars.text);
var indexValue = Number(vars.accent_word_index);
var accentWordIndex = Number.isFinite(indexValue) ? Math.trunc(indexValue) : 1;
var accentColors = {
green: "var(--brand, #71f5a7)",
blue: "var(--accent, #61a8ff)",
violet: "var(--accent-2, #b895ff)",
};
var accent = Object.prototype.hasOwnProperty.call(accentColors, vars.accent)
? vars.accent
: "green";
var shadow = !(vars.shadow === false || vars.shadow === "false");
var words = text.trim() === "" ? [] : text.trim().split(/\s+/);
root.style.setProperty("--hs-accent", accentColors[accent]);
headline.classList.toggle("hs-shadow", shadow);
headline.setAttribute("aria-label", text);
words.forEach(function (word, index) {
var span = document.createElement("span");
span.className = index === accentWordIndex ? "hs-word hs-word-accent" : "hs-word";
span.textContent = word;
span.setAttribute("aria-hidden", "true");
headline.appendChild(span);
});
// Deterministic fit from character count: DOM measurement is zero at
// mount time (the template is not laid out yet), so it never fires.
// 0.62 approximates the average glyph/em width of the bold face; the
// 56cqw rest-state cap keeps the 1.6x overshoot peak inside 90cqw.
var approxWidthCqw = text.length * 10.5 * 0.62;
if (approxWidthCqw > 56) {
var fitted = Math.max(3.5, 56 / (text.length * 0.62));
root.style.setProperty("--hs-font-size", fitted.toFixed(2) + "cqw");
}
var IN_BASE = 0.72;
var OUT_BASE = 0.46;
var LAND_AT_BASE = 0.58;
var SHAKE_FRAME_BASE = 1 / 30;
var duration = Math.max(0.001, parseFloat(root.dataset.duration || "3.5"));
var baseTotal = IN_BASE + OUT_BASE;
var envelopeScale = duration < baseTotal ? duration / baseTotal : 1;
var IN = IN_BASE * envelopeScale;
var OUT = OUT_BASE * envelopeScale;
var LAND_AT = LAND_AT_BASE * envelopeScale;
var SHAKE_FRAME = SHAKE_FRAME_BASE * envelopeScale;
var HOLD = Math.max(0, duration - IN - OUT);
var HOLD_START = IN;
var OUT_START = IN + HOLD;
var tl = gsap.timeline({ paused: true });
tl.fromTo(
headline,
{ scale: 1.6, opacity: 0, y: 0 },
{ scale: 1, opacity: 1, y: 0, duration: LAND_AT, ease: "expo.out" },
0,
);
tl.to(
stage,
{ x: "0.55cqw", y: "-0.3cqh", duration: SHAKE_FRAME, ease: "power2.out" },
LAND_AT,
);
tl.to(stage, {
x: "-0.38cqw",
y: "0.2cqh",
duration: SHAKE_FRAME,
ease: "power2.out",
});
tl.to(stage, { x: 0, y: 0, duration: SHAKE_FRAME, ease: "power2.out" });
if (HOLD > 0) {
tl.fromTo(
headline,
{ y: 0 },
{
y: "-0.55cqh",
duration: HOLD / 2,
ease: "sine.inOut",
yoyo: true,
repeat: 1,
immediateRender: false,
},
HOLD_START,
);
}
tl.to(headline, { y: "-120cqh", duration: OUT, ease: "power4.in" }, OUT_START);
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines["headline-slam"] = tl;
})();
</script>
</div>
</template>
</body>
</html>
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add headline-slam" item="headline-slam" />
That writes one file: `compositions/components/headline-slam.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/headline-slam.html` and copy what is inside into your own composition.
A component has no size or duration of its own. It takes both from the composition
you paste it into.
## 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 |
| --- | --- | --- | --- |
| `text` | `Ship it today` | string | Text displayed as the headline. |
| `accent_word_index` | `1` | number | Zero-based word index to color. Out of range leaves the headline unaccented. |
| `accent` | `green` | `green`, `blue`, `violet` | Color applied to the selected word. |
| `shadow` | `true` | boolean | Drop shadow cast under the headline. On by default; set false for a flat matte look. |
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
<div
data-composition-id="headline-slam"
data-composition-src="compositions/components/headline-slam.html"
data-variable-values='{"text":"Ship it today","accent_word_index":1,"accent":"green","shadow":true}'
></div>
```
{/* hf:generated-footer */}
Tagged `motion-primitive` `typography` `headline` `slam` `impact` `exit`.
## Related topics
- [Browse the complete Catalog](/catalog)
- [Add assets and Catalog items in the browser editor](/studio/assets-and-blocks)
- [Put blocks together into one video](/concepts/compositions)
</div>