HyperFrames-Registry
Die Registry stellt wiederverwendbare Blöcke und Komponenten bereit, die über hyperframes add <name> installiert werden können.
- Blöcke — eigenständige Sub-Kompositionen (eigene Abmessungen, Dauer, Timeline). Werden per
data-composition-srcin eine Host-Komposition eingebunden. - Komponenten — Effekt-Snippets (keine eigenen Abmessungen). Werden direkt in das HTML einer Host-Komposition eingefügt.
Kurzreferenz
hyperframes add data-chart # Einen Block installieren
hyperframes add grain-overlay # Eine Komponente installieren
hyperframes add shimmer-sweep --dir . # Ein bestimmtes Projekt anvisieren
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 fügt ein Snippet zum Einfügen in Ihre Host-Komposition ein. Das Snippet ist ein Ausgangspunkt – Sie müssen beim Verdrahten von Blöcken die Attribute data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index 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 der 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 via 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— Zeitpunkt, zu dem der Block in der Host-Timeline erscheint (Sekunden)data-duration— wie lange der Block abgespielt wirddata-width/data-height— Abmessungen der Block-Leinwanddata-track-index— Ebenen-Reihenfolge (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 Ihr Kompositions-Markup, ihr CSS in Ihren Style-Block und ihr JS in Ihr Skript ein (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-Styles - Kopieren Sie jeglichen
<script>-Inhalt in Ihr Kompositions-Skript (vor Ihrem Timeline-Code) - Wenn die Komponente eine GSAP-Timeline-Integration bereitstellt (siehe Kommentarblock im Snippet), fügen Sie diese Aufrufe zu Ihrer Timeline hinzu
Vollständige Details finden Sie unter wiring-components.md.
Erkennung
Durchsuchen Sie verfügbare Elemente:
# Registry-Manifest lesen
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Jedes registry-item.json eines Elements enthält: 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.
Beitragen eines neuen Blocks oder einer neuen Komponente
Um ein NEUES Registry-Element (Untertitel-Stil, VFX-Block, Übergang, Lower Third oder eine wiederverwendbare Komponente) zu erstellen und als Upstream-PR bereitzustellen – nicht um ein vorhandenes zu installieren – folgen Sie dem gesamten Workflow von der Idee über das Gerüst, den Bau, die Validierung, die Vorschau bis hin zum Versand unter contributing.md. Kopierfertige Startvorlagen (Untertitel / VFX / Komponente / registry-item.json) finden Sie in templates.md.