mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-04 07:19:52 +00:00
Miguel Ángel
9734578e60
Restores the 208 catalog items reverted after their previews 404'd in production, this time on the payload mechanism rather than the .html files that caused the outage. The generator no longer writes a preview document to docs/public. That writer, and the machinery under it, existed only to produce files the docs host discards, so it is gone rather than bypassed. Items now embed the composition itself via a payload, which is what the previous change already does for the items that were already in the catalog. The variables explorer is parked, not restored: it drove its preview through the same unpublished .html path, so it would have shown an empty frame. Items that declare variables get the live player plus the static variables table, and reconnecting the explorer to payloads is a follow-up.
195 lines
7.6 KiB
Plaintext
195 lines
7.6 KiB
Plaintext
---
|
|
title: "Skeleton Reveal"
|
|
description: "A skeleton loader transition that pulses, then cross-fades into content"
|
|
---
|
|
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
|
|
<iframe
|
|
className="w-full aspect-video rounded-xl border-0 bg-zinc-100 dark:bg-zinc-800"
|
|
title="skeleton-reveal preview"
|
|
loading="lazy"
|
|
srcDoc={`<!doctype html><html><head><meta charset="utf-8"><style>html,body{margin:0;height:100%;overflow:hidden;background:transparent}hyperframes-player{display:block;width:100%;height:100%}</style><script src="https://cdn.jsdelivr.net/npm/@hyperframes/player@0.7/dist/hyperframes-player.global.js"><\/script></head><body><script>fetch("/public/catalog/components/skeleton-reveal.json").then(function(r){return r.json()}).then(function(d){var p=document.createElement("hyperframes-player");p.setAttribute("srcdoc",d.html);p.setAttribute("controls","");p.setAttribute("autoplay","");p.setAttribute("loop","");p.setAttribute("muted","");p.setAttribute("poster","https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/skeleton-reveal.png");document.body.appendChild(p)});<\/script></body></html>`}
|
|
/>
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add skeleton-reveal" />
|
|
|
|
That writes one file: `compositions/components/skeleton-reveal.html`.
|
|
|
|
## 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 |
|
|
| --- | --- | --- | --- |
|
|
| `name` | `Jane Cooper` | string | Primary line revealed once the skeleton fades out. |
|
|
| `detail` | `jane@example.com` | string | Secondary line under the name, such as an email or a role. |
|
|
| `tone` | `light` | `light`, `dark` | Card palette. Light is the paper card, dark is a near-black card with the matching skeleton bars and text. |
|
|
|
|
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="skeleton-reveal"
|
|
data-composition-src="compositions/components/skeleton-reveal.html"
|
|
data-variable-values='{"name":"Jane Cooper","detail":"jane@example.com","tone":"light"}'
|
|
></div>
|
|
```
|
|
|
|
## Source
|
|
|
|
<Accordion title={`skeleton-reveal.html`}>
|
|
|
|
```html
|
|
<!--
|
|
Skeleton Reveal - transitions.dev-inspired primitive for HyperFrames.
|
|
|
|
Paste the markup and CSS into a composition. Use the timeline integration
|
|
note at the bottom as the starting point for deterministic GSAP animation.
|
|
|
|
Variables. The script reads each one, falls back to the declared default on
|
|
anything missing or invalid, and writes the result as a custom property the
|
|
CSS below consumes, or straight onto the revealed text. The timeline recipe
|
|
stays untouched: it keeps sweeping the skeleton and cross-fading to the
|
|
content, and these decide what that content says and what both halves look
|
|
like.
|
|
|
|
- name (string, default Jane Cooper): the primary line revealed once the
|
|
skeleton fades out. Blank falls back to the default.
|
|
- detail (string, default jane@example.com): the secondary line under the
|
|
name, such as an email or a role. Blank falls back to the default.
|
|
- tone (light | dark, default light): card palette. Light is the paper card
|
|
with grey bars, dark is a near-black card with the matching skeleton bars
|
|
and text, for compositions on a dark stage.
|
|
|
|
On every default the result is identical to the original: a white card that
|
|
shimmers, then reveals Jane Cooper and jane@example.com.
|
|
-->
|
|
|
|
<div
|
|
class="hf-transition-skeleton-reveal"
|
|
data-composition-variables='[
|
|
{ "id": "name", "type": "string", "role": "content", "label": "Name", "description": "Primary line revealed once the skeleton fades out.", "default": "Jane Cooper" },
|
|
{ "id": "detail", "type": "string", "role": "content", "label": "Detail", "description": "Secondary line under the name, such as an email or a role.", "default": "jane@example.com" },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Card palette. Light is the paper card, dark is a near-black card with the matching skeleton bars and text.", "default": "light", "options": [{ "value": "light", "label": "Light" }, { "value": "dark", "label": "Dark" }] }
|
|
]'
|
|
>
|
|
<div class="skeleton"></div>
|
|
<div class="content"><strong>Jane Cooper</strong><span>jane@example.com</span></div>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-transition-skeleton-reveal {
|
|
position: relative;
|
|
width: 340px;
|
|
height: 76px;
|
|
font-family: Inter, system-ui, sans-serif;
|
|
}
|
|
.hf-transition-skeleton-reveal .skeleton,
|
|
.hf-transition-skeleton-reveal .content {
|
|
position: absolute;
|
|
inset: 0;
|
|
border: 1px solid var(--hf-sr-border, #e4e4e7);
|
|
border-radius: 14px;
|
|
background: var(--hf-sr-surface, #fff);
|
|
}
|
|
.hf-transition-skeleton-reveal .skeleton {
|
|
background: linear-gradient(
|
|
90deg,
|
|
var(--hf-sr-bar, #f4f4f5),
|
|
var(--hf-sr-bar-strong, #e4e4e7),
|
|
var(--hf-sr-bar, #f4f4f5)
|
|
);
|
|
background-size: 240% 100%;
|
|
opacity: 1;
|
|
}
|
|
.hf-transition-skeleton-reveal .content {
|
|
display: grid;
|
|
align-content: center;
|
|
gap: 5px;
|
|
padding: 15px;
|
|
opacity: 0;
|
|
color: var(--hf-sr-ink, #18181b);
|
|
}
|
|
.hf-transition-skeleton-reveal span {
|
|
color: var(--hf-sr-muted, #71717a);
|
|
font-size: 14px;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
var tones = {
|
|
light: null,
|
|
dark: {
|
|
"--hf-sr-surface": "#18181b",
|
|
"--hf-sr-border": "#27272a",
|
|
"--hf-sr-bar": "#27272a",
|
|
"--hf-sr-bar-strong": "#3f3f46",
|
|
"--hf-sr-ink": "#fafafa",
|
|
"--hf-sr-muted": "#a1a1aa",
|
|
},
|
|
};
|
|
var defaultName = "Jane Cooper";
|
|
var defaultDetail = "jane@example.com";
|
|
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
function text(value, fallback) {
|
|
return typeof value === "string" && value.trim() ? value.trim() : fallback;
|
|
}
|
|
|
|
var tone = tones[pick(tones, vars.tone, "light")];
|
|
var name = text(vars.name, defaultName);
|
|
var detail = text(vars.detail, defaultDetail);
|
|
|
|
var roots = document.querySelectorAll(".hf-transition-skeleton-reveal");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
var root = roots[i];
|
|
if (tone) {
|
|
for (var key in tone) root.style.setProperty(key, tone[key]);
|
|
}
|
|
var strong = root.querySelector(".content strong");
|
|
var span = root.querySelector(".content span");
|
|
if (strong) strong.textContent = name;
|
|
if (span) span.textContent = detail;
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.to('.hf-transition-skeleton-reveal .skeleton', { backgroundPosition: '100% 0', duration: 0.7, ease: 'none' }, startTime); tl.to('.hf-transition-skeleton-reveal .skeleton', { opacity: 0, duration: 0.22 }, startTime + 0.72); tl.to('.hf-transition-skeleton-reveal .content', { opacity: 1, duration: 0.24 }, startTime + 0.78);
|
|
-->
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## Usage
|
|
|
|
Open `compositions/components/skeleton-reveal.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `video-primitive` `transition-primitive` `transitions-dev-port` `skeleton` `reveal`.
|
|
|
|
## Related topics
|
|
|
|
- [Browse the complete Catalog](/catalog)
|
|
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
|
- [Build a richer composition](/go-further)
|