Files
hyperframes/docs/catalog/components/fade-through.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

183 lines
7.7 KiB
Plaintext

---
title: "Fade Through"
description: "A calm transition primitive that fades one layer out, passes through a wash, and reveals the next layer"
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>Fade Through</h1>
<p>A calm transition primitive that fades one layer out, passes through a wash, and reveals the next layer</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/fade-through.json"
compositionId="fade-through"
compositionSrc="compositions/components/fade-through.html"
title="Fade Through"
variables={[{"id":"wash","type":"enum","role":"style","label":"Wash","description":"Colour of the mid-transition frame. Paper resolves through --hf-fade-through-wash, accent rides --accent.","default":"paper","options":[{"value":"paper","label":"Paper"},{"value":"white","label":"White"},{"value":"ink","label":"Ink"},{"value":"accent","label":"Accent"}]},{"id":"strength","type":"number","role":"style","label":"Strength","description":"How far the wash covers at its peak. 1 is a full flash, 0.3 a light veil.","default":1,"min":0.1,"max":1,"step":0.05},{"id":"shape","type":"enum","role":"style","label":"Shape","description":"Flat fills the frame evenly, bloom concentrates the wash in the centre.","default":"flat","options":[{"value":"flat","label":"Flat"},{"value":"bloom","label":"Bloom"}]}]}
meta={{"category":"Effects","badge":"Stable","codeLines":96}}
attribution={{"path":"registry/components/fade-through","tags":["motion-primitive","transition","fade","crossfade","scene"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/fade-through/fade-through.html"
>
<CatalogSlot slot="code">
```html fade-through.html
<!--
Fade Through - scene transition primitive.
Put class="hf-fade-through-out" on the outgoing layer and
class="hf-fade-through-in" on the incoming layer. Add the optional wash
overlay below when you want a brighter mid-transition frame.
Variables. The wash is the only surface this primitive paints, so all three
describe it. 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 above consumes. The timeline recipe below is untouched by them.
- wash (paper | white | ink | accent, default paper): the colour of the
mid-transition frame. paper still resolves through
--hf-fade-through-wash, so an existing override keeps working; accent
rides --accent.
- strength (number 0.1 to 1, default 1): how far the wash is allowed to
cover at its peak. 1 is a full flash, 0.3 a light veil over the cut.
- shape (flat | bloom, default flat): flat fills the frame evenly, bloom
concentrates the wash in the centre and falls off to the edges.
On every default the result is identical to the original: a flat, fully
opaque #f8f5ec wash.
-->
<div
class="hf-fade-through-wash"
aria-hidden="true"
data-composition-variables='[
{ "id": "wash", "type": "enum", "role": "style", "label": "Wash", "description": "Colour of the mid-transition frame. Paper resolves through --hf-fade-through-wash, accent rides --accent.", "default": "paper", "options": [{ "value": "paper", "label": "Paper" }, { "value": "white", "label": "White" }, { "value": "ink", "label": "Ink" }, { "value": "accent", "label": "Accent" }] },
{ "id": "strength", "type": "number", "role": "style", "label": "Strength", "description": "How far the wash covers at its peak. 1 is a full flash, 0.3 a light veil.", "default": 1, "min": 0.1, "max": 1, "step": 0.05 },
{ "id": "shape", "type": "enum", "role": "style", "label": "Shape", "description": "Flat fills the frame evenly, bloom concentrates the wash in the centre.", "default": "flat", "options": [{ "value": "flat", "label": "Flat" }, { "value": "bloom", "label": "Bloom" }] }
]'
></div>
<style>
.hf-fade-through-in {
opacity: 0;
}
.hf-fade-through-wash {
position: absolute;
inset: 0;
opacity: 0;
pointer-events: none;
background: var(--hf-fade-through-paint, var(--hf-fade-through-wash, #f8f5ec));
filter: opacity(var(--hf-fade-through-strength, 1));
z-index: 900;
}
</style>
<script>
(function () {
"use strict";
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
// Unrecognised overrides return to their declared defaults.
var washes = {
paper: "var(--hf-fade-through-wash, #f8f5ec)",
white: "#ffffff",
ink: "#0b0b0f",
accent: "var(--accent, #38bdf8)",
};
var wash = Object.prototype.hasOwnProperty.call(washes, vars.wash) ? vars.wash : "paper";
var shape = vars.shape === "bloom" ? "bloom" : "flat";
var strength = parseFloat(vars.strength);
if (!isFinite(strength)) strength = 1;
strength = Math.min(1, Math.max(0.1, strength));
var colour = washes[wash];
var paint =
shape === "bloom"
? "radial-gradient(circle at 50% 50%, " + colour + " 0%, transparent 72%)"
: colour;
var overlays = document.querySelectorAll(".hf-fade-through-wash");
for (var i = 0; i < overlays.length; i += 1) {
overlays[i].style.setProperty("--hf-fade-through-paint", paint);
overlays[i].style.setProperty("--hf-fade-through-strength", String(strength));
}
})();
</script>
<!--
Timeline integration:
tl.to(".hf-fade-through-out", { opacity: 0, duration: 0.45, ease: "power2.inOut" }, startTime);
tl.to(".hf-fade-through-wash", { opacity: 1, duration: 0.35, ease: "power2.inOut" }, startTime);
tl.to(".hf-fade-through-wash", { opacity: 0, duration: 0.45, ease: "power2.inOut" }, startTime + 0.35);
tl.to(".hf-fade-through-in", { opacity: 1, duration: 0.55, ease: "power2.out" }, startTime + 0.35);
-->
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add fade-through" item="fade-through" />
That writes one file: `compositions/components/fade-through.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/fade-through.html` and copy what is inside into your own composition.
The file opens with a comment header that walks you through it.
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 |
| --- | --- | --- | --- |
| `wash` | `paper` | `paper`, `white`, `ink`, `accent` | Colour of the mid-transition frame. Paper resolves through --hf-fade-through-wash, accent rides --accent. |
| `strength` | `1` | 0.1 to 1, step 0.05 | How far the wash covers at its peak. 1 is a full flash, 0.3 a light veil. |
| `shape` | `flat` | `flat`, `bloom` | Flat fills the frame evenly, bloom concentrates the wash in the centre. |
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="fade-through"
data-composition-src="compositions/components/fade-through.html"
data-variable-values='{"wash":"paper","strength":1,"shape":"flat"}'
></div>
```
{/* hf:generated-footer */}
Tagged `motion-primitive` `transition` `fade` `crossfade` `scene`.
## 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>