HyperFrames-Registry
Die Registry stellt wiederverwendbare Blöcke und Komponenten bereit, die über hyperframes add <name> installiert werden können.
- Blöcke — eigenständige Unterkompositionen (eigene Dimensionen, Dauer, Zeitleiste). Werden über
data-composition-srcin eine Host-Komposition eingebunden. - Komponenten — Effekt-Snippets (keine eigenen Dimensionen). Werden direkt in das HTML einer Host-Komposition eingefügt.
Kurzreferenz
hyperframes add data-chart # installiert einen Block
hyperframes add grain-overlay # installiert eine Komponente
hyperframes add shimmer-sweep --dir . # zielt auf ein bestimmtes Projekt
hyperframes add data-chart --json # maschinenlesbare Ausgabe
hyperframes add data-chart --no-clipboard # überspringt Zwischenablage (CI/headless)
Nach der Installation gibt die CLI aus, welche Dateien geschrieben wurden, sowie ein Snippet, das in Ihre Host-Komposition eingefügt werden kann. Das Snippet ist ein Ausgangspunkt – Sie müssen die Attribute data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index beim Verdrahten von Blöcken hinzufügen.
Hinweis: hyperframes add funktioniert nur für Blöcke und Komponenten. Für Beispiele verwenden Sie stattdessen hyperframes init <dir> --example <name>.
Installationsorte
Blöcke werden standardmäßig unter compositions/<name>.html installiert.
Komponenten werden standardmäßig unter compositions/components/<name>.html installiert.
Diese Pfade sind in hyperframes.json konfigurierbar:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
Vollständige Details finden Sie unter install-locations.md.
Verdrahten von Blöcken
Blöcke sind eigenständige Kompositionen – binden Sie sie über data-composition-src in Ihre Host-index.html ein:
<div
data-composition-id="data-chart"
data-composition-src="compositions/data-chart.html"
data-start="2"
data-duration="15"
data-track-index="1"
data-width="1920"
data-height="1080"
></div>
Wichtige Attribute:
data-composition-src— Pfad zur Block-HTML-Dateidata-composition-id— muss mit der internen ID des Blocks übereinstimmendata-start— wann der Block in der Host-Zeitleiste erscheint (Sekunden)data-duration— wie lange der Block abgespielt wirddata-width/data-height— Block-Leinwanddimensionendata-track-index— Ebenenreihenfolge (höher = weiter vorne)
Vollständige Details finden Sie unter wiring-blocks.md.
Verdrahten von Komponenten
Komponenten sind Snippets – fügen Sie ihr HTML in das Markup Ihrer Komposition ein, ihr CSS in den Style-Block und ihr JS (falls vorhanden) in Ihr Skript:
- Lesen Sie die installierte Datei (z. B.
compositions/components/grain-overlay.html) - Kopieren Sie die HTML-Elemente in den
<div data-composition-id="...">Ihrer Komposition - Kopieren Sie den
<style>-Block in die Styles Ihrer Komposition - Kopieren Sie jeglichen
<script>-Inhalt in das Skript Ihrer Komposition (vor Ihrem Zeitleisten-Code) - Wenn die Komponente eine GSAP-Zeitleistenintegration bereitstellt (siehe Kommentarblock im Snippet), fügen Sie diese Aufrufe zu Ihrer Zeitleiste hinzu
Vollständige Details finden Sie unter wiring-components.md.
Erkennung
Durchsuchen Sie verfügbare Elemente:
# Lesen des Registry-Manifests
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Die registry-item.json jedes Elements enthält: Name, Typ, Titel, Beschreibung, Tags, Dimensionen (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Details zum Filtern nach Typ und Tags finden Sie unter discovery.md.
Beitragen eines neuen Blocks oder einer neuen Komponente
Um ein NEUES Registry-Element (Bildstil, VFX-Block, Übergang, Lower Third oder eine wiederverwendbare Komponente) zu erstellen und als Upstream-PR zu versenden – nicht um ein vorhandenes zu installieren – folgen Sie dem vollständigen Workflow von Idee → Gerüst → Bauen → Validieren → Vorschau → Versand in contributing.md. Kopierfertige Startvorlagen (Bild / VFX / Komponente / registry-item.json) finden Sie in templates.md.