mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 07:50:13 +00:00
* 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.
232 lines
9.3 KiB
Plaintext
232 lines
9.3 KiB
Plaintext
---
|
|
title: "Directional Wipe"
|
|
description: "A directional scene push that slides one panel over another."
|
|
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>Directional Wipe</h1>
|
|
<p>A directional scene push that slides one panel over another.</p>
|
|
</div>
|
|
|
|
<CatalogDetail
|
|
previewSrc="/public/catalog/components/directional-wipe.json"
|
|
compositionId="directional-wipe"
|
|
compositionSrc="compositions/components/directional-wipe.html"
|
|
title="Directional Wipe"
|
|
variables={[{"id":"palette","type":"enum","role":"style","label":"Palette","description":"Theme token for the ring marking the incoming panel. Slate rides --accent, teal --brand, ember --accent-2; each falls back to a neutral hairline.","default":"slate","options":[{"value":"slate","label":"Slate"},{"value":"teal","label":"Teal"},{"value":"ember","label":"Ember"}]},{"id":"corner","type":"enum","role":"style","label":"Corner","description":"Corner radius of the transition card.","default":"rounded","options":[{"value":"square","label":"Square"},{"value":"rounded","label":"Rounded"},{"value":"soft","label":"Soft"}]}]}
|
|
meta={{"category":"Effects","badge":"Stable","codeLines":146}}
|
|
attribution={{"path":"registry/components/directional-wipe","tags":["transition-primitive"]}}
|
|
hasCode
|
|
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/directional-wipe/directional-wipe.html"
|
|
>
|
|
|
|
<CatalogSlot slot="code">
|
|
|
|
```html directional-wipe.html
|
|
<!--
|
|
Directional Wipe - catalog component for HyperFrames.
|
|
|
|
Paste the markup and CSS into a composition. Drive the timeline integration
|
|
from a paused GSAP timeline so renders remain deterministic.
|
|
|
|
Variables. The script below reads each one, falls back to the declared
|
|
default on anything missing or unrecognised, and writes the result as a
|
|
custom property the CSS consumes. The timeline recipe at the bottom is
|
|
untouched by them.
|
|
|
|
- palette (slate | teal | ember, default slate): ink of the ring that marks
|
|
the incoming panel. Both panels are monochrome placeholder material; the
|
|
ring is the one accent-coloured element. slate rides --accent, teal rides
|
|
--brand, ember rides --accent-2, and each falls back to a neutral hairline
|
|
so an unthemed composition renders in black and white.
|
|
- corner (square | rounded | soft, default rounded): corner radius of the
|
|
card. square is 0, rounded the original 30px, soft 56px.
|
|
|
|
On every default the motion is unchanged.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-directional-wipe"
|
|
data-composition-variables='[
|
|
{ "id": "palette", "type": "enum", "role": "style", "label": "Palette", "description": "Theme token for the ring marking the incoming panel. Slate rides --accent, teal --brand, ember --accent-2; each falls back to a neutral hairline.", "default": "slate", "options": [{ "value": "slate", "label": "Slate" }, { "value": "teal", "label": "Teal" }, { "value": "ember", "label": "Ember" }] },
|
|
{ "id": "corner", "type": "enum", "role": "style", "label": "Corner", "description": "Corner radius of the transition card.", "default": "rounded", "options": [{ "value": "square", "label": "Square" }, { "value": "rounded", "label": "Rounded" }, { "value": "soft", "label": "Soft" }] }
|
|
]'
|
|
>
|
|
<div class="scene from">Before</div>
|
|
<div class="scene to">Directional Wipe</div>
|
|
<div class="fx"></div>
|
|
<div class="rgb"></div>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-directional-wipe {
|
|
--hf-accent: var(--accent, rgba(255, 255, 255, 0.28));
|
|
--hf-l1: rgba(255, 255, 255, 0.72);
|
|
--hf-l3: rgba(255, 255, 255, 0.18);
|
|
--hf-l4: rgba(255, 255, 255, 0.08);
|
|
--hf-hair: rgba(255, 255, 255, 0.14);
|
|
--hf-ink: #111827;
|
|
--hf-muted: #6b7280;
|
|
--hf-surface: #ffffff;
|
|
color: var(--hf-ink);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
}
|
|
.hf-catalog-directional-wipe {
|
|
position: relative;
|
|
width: 760px;
|
|
height: 428px;
|
|
overflow: hidden;
|
|
border-radius: var(--hf-corner, 30px);
|
|
background: #111827;
|
|
box-shadow: 0 28px 80px rgba(15, 23, 42, 0.2);
|
|
}
|
|
.hf-catalog-directional-wipe .scene {
|
|
position: absolute;
|
|
inset: 0;
|
|
display: grid;
|
|
place-items: center;
|
|
font-weight: 900;
|
|
font-size: 58px;
|
|
letter-spacing: -0.05em;
|
|
color: #fff;
|
|
}
|
|
.hf-catalog-directional-wipe .from {
|
|
background:
|
|
repeating-linear-gradient(90deg, rgba(255, 255, 255, 0.04) 0 1px, transparent 1px 4px),
|
|
var(--hf-l4);
|
|
transform: translate(var(--hf-from-x, 0px), var(--hf-from-y, 0px))
|
|
scale(var(--hf-from-scale, 1));
|
|
filter: blur(var(--hf-from-blur, 0px));
|
|
}
|
|
.hf-catalog-directional-wipe .to {
|
|
background:
|
|
repeating-linear-gradient(90deg, rgba(255, 255, 255, 0.05) 0 1px, transparent 1px 4px),
|
|
var(--hf-l3);
|
|
box-shadow: inset 0 0 0 2px var(--hf-accent);
|
|
transform: translate(var(--hf-to-x, 0px), var(--hf-to-y, 0px)) scale(var(--hf-to-scale, 1));
|
|
clip-path: inset(
|
|
var(--hf-clip-top, 0%) var(--hf-clip-right, 100%) var(--hf-clip-bottom, 0%)
|
|
var(--hf-clip-left, 0%)
|
|
);
|
|
}
|
|
.hf-catalog-directional-wipe .fx {
|
|
position: absolute;
|
|
inset: 0;
|
|
background: linear-gradient(90deg, transparent, rgba(255, 255, 255, 0.75), transparent);
|
|
mix-blend-mode: screen;
|
|
transform: translateX(var(--hf-fx-x, -110%));
|
|
}
|
|
.hf-catalog-directional-wipe .rgb {
|
|
position: absolute;
|
|
inset: 0;
|
|
pointer-events: none;
|
|
opacity: var(--hf-rgb-opacity, 0);
|
|
background: linear-gradient(
|
|
90deg,
|
|
rgba(239, 68, 68, 0.35),
|
|
transparent,
|
|
rgba(34, 211, 238, 0.35)
|
|
);
|
|
transform: translateX(var(--hf-rgb-x, 0px));
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides fall back to their declared defaults.
|
|
// Theme tokens only. The neutral fallback keeps an unthemed mount monochrome.
|
|
var HAIRLINE = "rgba(255, 255, 255, 0.28)";
|
|
var palettes = {
|
|
slate: "var(--accent, " + HAIRLINE + ")",
|
|
teal: "var(--brand, " + HAIRLINE + ")",
|
|
ember: "var(--accent-2, " + HAIRLINE + ")",
|
|
};
|
|
var corners = { square: "0px", rounded: "30px", soft: "56px" };
|
|
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
var palette = palettes[pick(palettes, vars.palette, "slate")];
|
|
var corner = corners[pick(corners, vars.corner, "rounded")];
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-directional-wipe");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-accent", palette);
|
|
roots[i].style.setProperty("--hf-corner", corner);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-directional-wipe .to', { '--hf-clip-right': '100%', '--hf-to-x': '60px', '--hf-to-scale': 1.04 }, { '--hf-clip-right': '0%', '--hf-to-x': '0px', '--hf-to-scale': 1, duration: 0.9, ease: 'power3.inOut' }, startTime); tl.to('.hf-catalog-directional-wipe .from', { '--hf-from-x': '-70px', '--hf-from-scale': 0.96, '--hf-from-blur': '5px', duration: 0.9, ease: 'power3.inOut' }, startTime); tl.fromTo('.hf-catalog-directional-wipe .fx', { '--hf-fx-x': '-110%' }, { '--hf-fx-x': '110%', duration: 0.58, ease: 'power2.inOut' }, startTime + 0.18); tl.fromTo('.hf-catalog-directional-wipe .rgb', { '--hf-rgb-opacity': 0, '--hf-rgb-x': '-16px' }, { '--hf-rgb-opacity': 1, '--hf-rgb-x': '16px', repeat: 3, yoyo: true, duration: 0.07, ease: 'steps(1)' }, startTime + 0.32);
|
|
-->
|
|
```
|
|
|
|
</CatalogSlot>
|
|
|
|
<CatalogSlot slot="install">
|
|
|
|
<InstallCommand command="npx hyperframes add directional-wipe" item="directional-wipe" />
|
|
|
|
That writes one file: `compositions/components/directional-wipe.html`.
|
|
|
|
</CatalogSlot>
|
|
|
|
</CatalogDetail>
|
|
|
|
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/directional-wipe.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 |
|
|
| --- | --- | --- | --- |
|
|
| `palette` | `slate` | `slate`, `teal`, `ember` | Theme token for the ring marking the incoming panel. Slate rides --accent, teal --brand, ember --accent-2; each falls back to a neutral hairline. |
|
|
| `corner` | `rounded` | `square`, `rounded`, `soft` | Corner radius of the transition card. |
|
|
|
|
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="directional-wipe"
|
|
data-composition-src="compositions/components/directional-wipe.html"
|
|
data-variable-values='{"palette":"slate","corner":"rounded"}'
|
|
></div>
|
|
```
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `transition-primitive`.
|
|
|
|
## 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>
|