Skip to content

Write HTML. Render video. Built for agents.

3.2 KB
Raw Blame
---
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";

<CatalogDetail
  previewSrc="/public/catalog/components/vignette.json"
  compositionId="vignette"
  compositionSrc="compositions/components/vignette.html"
  title="Vignette"
  description="Cinematic radial vignette overlay using a pure-CSS gradient — darkens the edges to pull focus toward the center"
  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>

<CatalogSlot slot="docs">

## 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 Studio](/studio/assets-and-blocks)
- [Build a richer composition](/go-further)

</CatalogSlot>

</CatalogDetail>