HyperFrames Registry
Die Registry stellt wiederverwendbare Blöcke und Komponenten bereit, die über hyperframes add <name> installiert werden können.
- Blöcke — eigenständige Subkompositionen (eigene Dimensionen, Dauer, Timeline). 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 # Block installieren
hyperframes add grain-overlay # Komponente installieren
hyperframes add shimmer-sweep --dir . # Ein bestimmtes Projekt ansprechen
hyperframes add data-chart --json # Maschinenlesbare Ausgabe
hyperframes add data-chart --no-clipboard # Zwischenablage überspringen (CI/headless)
Nach der Installation gibt die CLI aus, welche Dateien geschrieben wurden und ein Snippet zum Einfügen in Ihre Host-Komposition. 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 bei der Verdrahtung 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 in compositions/<name>.html installiert.
Komponenten werden standardmäßig in 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"
}
}
Weitere Details finden Sie unter install-locations.md.
Blöcke verdrahten
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-Timeline erscheint (Sekunden)data-duration— wie lange der Block abgespielt wirddata-width/data-height— Block-Leinwandabmessungendata-track-index— Ebenenreihenfolge (höher = weiter vorne)
Weitere Details finden Sie unter wiring-blocks.md.
Komponenten verdrahten
Komponenten sind Snippets – fügen Sie ihr HTML in das Markup Ihrer Komposition ein, ihr CSS in Ihren Style-Block und ihr JS in Ihr Skript (falls vorhanden):
- Lesen Sie die installierte Datei (z. B.
compositions/components/grain-overlay.html) - Kopieren Sie die HTML-Elemente in Ihr
<div data-composition-id="..."> - Kopieren Sie den
<style>-Block in Ihre Kompositions-Stile - Kopieren Sie etwaige
<script>-Inhalte in das Skript Ihrer Komposition (vor Ihrem Timeline-Code) - Wenn die Komponente eine GSAP-Timeline-Integration bereitstellt (siehe Kommentarblock im Snippet), fügen Sie diese Aufrufe in Ihre Timeline ein
Weitere Details finden Sie unter wiring-components.md.
Erkennung
Verfügbare Elemente durchsuchen:
# Registry-Manifest lesen
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Jedes Element enthält in seiner registry-item.json: Name, Typ, Titel, Beschreibung, Tags, Abmessungen (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Details zum Filtern nach Typ und Tags finden Sie unter discovery.md.
Einen neuen Block oder eine neue Komponente beisteuern
Um ein NEUES Registry-Element (Bildunterschriften-Stil, 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 → Scaffold → Bauen → Validieren → Vorschau → Versand in contributing.md. Startvorlagen (Bildunterschrift / VFX / Komponente / registry-item.json) zum Kopieren und Einfügen finden Sie in templates.md.