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

116 lines
3.4 KiB
Plaintext

---
title: "Vignette"
description: "Cinematic radial vignette overlay using a pure-CSS gradient — darkens the edges to pull focus toward the center"
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>Vignette</h1>
<p>Cinematic radial vignette overlay using a pure-CSS gradient — darkens the edges to pull focus toward the center</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/vignette.json"
compositionId="vignette"
compositionSrc="compositions/components/vignette.html"
title="Vignette"
variables={[]}
meta={{"category":"Effects","badge":"Stable","codeLines":51}}
attribution={{"path":"registry/components/vignette","tags":["vignette","overlay","cinematic","effect"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/vignette/vignette.html"
>
<CatalogSlot slot="code">
```html vignette.html
<!--
Vignette — cinematic radial darkening overlay.
Usage: paste this snippet inside your composition's positioned stage.
The overlay covers the full viewport with pointer-events: none so it
sits on top of all content without blocking interaction.
Customize:
- --vignette-color: edge color and alpha (default rgba(0, 0, 0, 0.7))
- --vignette-size: where the transparent center ends (default 45%)
- --vignette-edge: where the color reaches its final stop (default 100%)
- --vignette-shape: ellipse | circle (default ellipse)
- z-index: defaults to 90 so grain-overlay (100) reads on top
-->
<div
id="hf-vignette"
style="
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
pointer-events: none;
z-index: 90;
"
></div>
<style>
#hf-vignette {
background: radial-gradient(
var(--vignette-shape, ellipse) at center,
transparent var(--vignette-size, 45%),
var(--vignette-color, rgba(0, 0, 0, 0.7)) var(--vignette-edge, 100%)
);
}
</style>
<!--
Timeline integration example (add to your composition's GSAP timeline):
// Fade the vignette in over the first second
tl.fromTo("#hf-vignette",
{ "--vignette-color": "rgba(0, 0, 0, 0)" },
{ "--vignette-color": "rgba(0, 0, 0, 0.7)", duration: 1, ease: "power2.out" },
0,
);
// Or breathe the size in and out (works with any easing)
tl.to("#hf-vignette", { "--vignette-size": "35%", duration: 1, ease: "sine.inOut" }, 2);
-->
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add vignette" item="vignette" />
That writes one file: `compositions/components/vignette.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/vignette.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.
{/* hf:generated-footer */}
Tagged `vignette` `overlay` `cinematic` `effect`.
## 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>