Files
hyperframes/docs/catalog/components/caption-highlight.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

325 lines
10 KiB
Plaintext

---
title: "Highlight"
description: "Red background sweep behind each active word, TikTok-style"
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>Highlight</h1>
<p>Red background sweep behind each active word, TikTok-style</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/caption-highlight.json"
compositionId="caption-highlight"
compositionSrc="compositions/components/caption-highlight.html"
title="Highlight"
variables={[]}
meta={{"category":"Captions","badge":"Stable","codeLines":261}}
attribution={{"path":"registry/components/caption-highlight","tags":["captions","caption-style","highlight","social","tiktok"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/caption-highlight/caption-highlight.html"
>
<CatalogSlot slot="code">
```html caption-highlight.html
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=1920, height=1080" />
<title>Highlight</title>
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=Montserrat:wght@800&display=swap"
rel="stylesheet"
/>
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}
html,
body {
width: 1920px;
height: 1080px;
margin: 0;
overflow: hidden;
background: transparent;
}
#highlight {
pointer-events: none;
position: relative;
width: 1920px;
height: 1080px;
overflow: hidden;
background: transparent;
}
#hl-video {
position: absolute;
inset: 0;
z-index: 0;
width: 100%;
height: 100%;
object-fit: cover;
}
.hl-overlay {
position: absolute;
inset: 0;
background: transparent;
z-index: 1;
pointer-events: none;
}
#hl-container {
position: absolute;
inset: 0;
z-index: 10;
pointer-events: none;
}
.hl-group {
position: absolute;
bottom: 140px;
left: 0;
width: 100%;
display: flex;
flex-wrap: wrap;
align-items: flex-end;
justify-content: center;
gap: 8px;
padding: 0 100px;
opacity: 0;
visibility: hidden;
}
.hl-word {
font-family: "Montserrat", sans-serif;
font-weight: 800;
font-size: 80px;
text-transform: uppercase;
color: #ffffff;
display: inline-block;
letter-spacing: 0.02em;
line-height: 1;
position: relative;
padding: 6px 12px 8px;
text-shadow: 0 6px 18px rgba(0, 0, 0, 0.45);
transform-origin: 50% 58%;
will-change: transform, filter;
}
.hl-word-bg {
position: absolute;
inset: 0;
background: linear-gradient(135deg, #ff1745 0%, #df1238 100%);
border-radius: 10px;
box-shadow: 0 12px 30px rgba(229, 20, 58, 0.32);
opacity: 0;
transform: scaleX(0);
transform-origin: 0% 50%;
z-index: -1;
}
.hl-word-text {
position: relative;
z-index: 1;
}
</style>
</head>
<body>
<div
id="highlight"
data-composition-id="caption-highlight"
data-timeline-locked
data-start="0"
data-duration="8"
data-fps="30"
data-width="1920"
data-height="1080"
>
<div class="hl-overlay"></div>
<div id="hl-container"></div>
</div>
<script>
(function () {
window.__timelines = window.__timelines || {};
var _fitCanvas = document.createElement("canvas");
var _fitCtx = _fitCanvas.getContext("2d");
function fitFontSize(text, baseFontSize, fontWeight, fontFamily, maxWidth) {
var size = baseFontSize;
var minSize = Math.floor(baseFontSize * 0.45);
while (size > minSize) {
_fitCtx.font = fontWeight + " " + size + "px " + fontFamily;
if (_fitCtx.measureText(text).width <= maxWidth) return size;
size -= 2;
}
return minSize;
}
var WORDS = [
{ text: "Every", start: 0.0, end: 0.3 },
{ text: "great", start: 0.3, end: 0.55 },
{ text: "video", start: 0.55, end: 0.85 },
{ text: "starts", start: 0.85, end: 1.1 },
{ text: "with", start: 1.1, end: 1.25 },
{ text: "a", start: 1.25, end: 1.35 },
{ text: "single", start: 1.35, end: 1.65 },
{ text: "frame.", start: 1.65, end: 2.0 },
{ text: "HyperFrames", start: 2.1, end: 2.65 },
{ text: "lets", start: 2.65, end: 2.85 },
{ text: "you", start: 2.85, end: 2.95 },
{ text: "write", start: 2.95, end: 3.15 },
{ text: "HTML", start: 3.15, end: 3.55 },
{ text: "and", start: 3.55, end: 3.65 },
{ text: "render", start: 3.65, end: 3.95 },
{ text: "professional", start: 3.95, end: 4.45 },
{ text: "video.", start: 4.45, end: 4.8 },
{ text: "No", start: 4.9, end: 5.05 },
{ text: "timeline.", start: 5.05, end: 5.45 },
{ text: "No", start: 5.5, end: 5.65 },
{ text: "drag", start: 5.65, end: 5.85 },
{ text: "and", start: 5.85, end: 5.95 },
{ text: "drop.", start: 5.95, end: 6.25 },
{ text: "Just", start: 6.35, end: 6.55 },
{ text: "code", start: 6.55, end: 6.8 },
{ text: "that", start: 6.8, end: 6.95 },
{ text: "becomes", start: 6.95, end: 7.3 },
{ text: "cinema.", start: 7.3, end: 7.7 },
];
var RAW_GROUPS = [
[0, 3],
[4, 7],
[8, 8],
[9, 12],
[13, 15],
[16, 16],
[17, 19],
[20, 22],
[23, 24],
[25, 27],
];
var GROUPS = RAW_GROUPS.map(function (pair, gi) {
var ws = pair[0],
we = pair[1];
var nextStart = gi + 1 < RAW_GROUPS.length ? WORDS[RAW_GROUPS[gi + 1][0]].start : 8.0;
var gEnd = Math.min(WORDS[we].end + 0.5, nextStart - 0.05);
return { wordStart: ws, wordEnd: we, start: WORDS[ws].start, end: gEnd };
});
var container = document.getElementById("hl-container");
var tl = gsap.timeline({ paused: true });
GROUPS.forEach(function (g, gi) {
var groupWords = WORDS.slice(g.wordStart, g.wordEnd + 1);
var grp = document.createElement("div");
grp.className = "hl-group";
grp.id = "hl-grp-" + gi;
var groupText = groupWords
.map(function (w) {
return w.text.toUpperCase();
})
.join(" ");
var computedSize = fitFontSize(groupText, 80, "800", "Montserrat", 1620);
groupWords.forEach(function (w, i) {
var wi = g.wordStart + i;
var wordEl = document.createElement("span");
wordEl.className = "hl-word";
wordEl.id = "hl-w-" + wi;
wordEl.style.fontSize = computedSize + "px";
var bgEl = document.createElement("span");
bgEl.className = "hl-word-bg";
bgEl.id = "hl-bg-" + wi;
var textEl = document.createElement("span");
textEl.className = "hl-word-text";
textEl.textContent = w.text.toUpperCase();
wordEl.appendChild(bgEl);
wordEl.appendChild(textEl);
grp.appendChild(wordEl);
});
container.appendChild(grp);
tl.set(grp, { visibility: "visible" }, g.start);
tl.fromTo(
grp,
{ opacity: 0 },
{ opacity: 1, duration: 0.12, ease: "power2.out" },
g.start,
);
groupWords.forEach(function (w, i) {
var wi = g.wordStart + i;
var bgEl = document.getElementById("hl-bg-" + wi);
var wordEl = document.getElementById("hl-w-" + wi);
tl.to(bgEl, { opacity: 1, scaleX: 1, duration: 0.15, ease: "power2.out" }, w.start);
tl.to(
wordEl,
{ filter: "brightness(1.05)", duration: 0.08, ease: "power2.out" },
w.start,
);
tl.to(
wordEl,
{ filter: "brightness(1)", duration: 0.16, ease: "power2.out" },
w.start + 0.08,
);
tl.to(bgEl, { opacity: 0, scaleX: 1.02, duration: 0.1, ease: "power2.in" }, w.end);
tl.set(bgEl, { scaleX: 0 }, w.end + 0.1);
});
tl.to(grp, { opacity: 0, duration: 0.1, ease: "power2.in" }, g.end - 0.1);
tl.set(grp, { opacity: 0, visibility: "hidden" }, g.end);
});
tl.seek(0);
window.__timelines["caption-highlight"] = tl;
})();
</script>
</body>
</html>
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add caption-highlight" item="caption-highlight" />
That writes one file: `compositions/components/caption-highlight.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/caption-highlight.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.
{/* hf:generated-footer */}
Tagged `captions` `caption-style` `highlight` `social` `tiktok`.
## 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>