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 Abmessungen, Dauer, Zeitleiste). Werden über
data-composition-srcin einer Host-Komposition eingebunden. - Komponenten — Effekt-Snippets (keine eigenen Abmessungen). Werden direkt in das HTML einer Host-Komposition eingefügt.
Kurzreferenz
hyperframes add data-chart # installiere einen Block
hyperframes add grain-overlay # installiere eine Komponente
hyperframes add shimmer-sweep --dir . # auf ein bestimmtes Projekt abzielen
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, das in die Host-Komposition eingefügt werden kann. Das Snippet ist ein Startpunkt – Sie müssen data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index-Attribute hinzufügen, wenn Sie Blöcke verkabeln.
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"
}
}
Siehe install-locations.md für vollständige Details.
Verkabeln 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— Abmessungen der Block-Leinwanddata-track-index— Ebenen-Reihenfolge (höher = weiter vorne)
Siehe wiring-blocks.md für vollständige Details.
Verkabeln von Komponenten
Komponenten sind Snippets – fügen Sie deren HTML in das Markup Ihrer Komposition, deren CSS in Ihren Style-Block und deren JS in Ihr Skript (falls vorhanden) ein:
- Lesen Sie die installierte Datei (z. B.
compositions/components/grain-overlay.html) - Kopieren Sie die HTML-Elemente in das
<div data-composition-id="...">Ihrer Komposition - Kopieren Sie den
<style>-Block in die Styles Ihrer Komposition - Kopieren Sie alle
<script>-Inhalte in das Skript Ihrer Komposition (vor Ihrem Zeitleisten-Code) - Wenn die Komponente eine GSAP-Zeitleisten-Integration bereitstellt (siehe Kommentarblock im Snippet), fügen Sie diese Aufrufe Ihrer Zeitleiste hinzu
Siehe wiring-components.md für vollständige Details.
Erkundung
Durchsuchen Sie verfügbare Elemente:
# Lesen des Registry-Manifests
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Das registry-item.json jedes Elements enthält: Name, Typ, Titel, Beschreibung, Tags, Abmessungen (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Siehe discovery.md für Details zum Filtern nach Typ und Tags.
Beitragen eines neuen Blocks oder einer Komponente
Um ein NEUES Registry-Element zu erstellen (Untertitelstil, VFX-Block, Übergang, Lower Third oder eine wiederverwendbare Komponente) und es als Upstream-PR einzureichen – nicht ein bestehendes installieren – folgen Sie dem vollständigen Workflow von Idee → Scaffold → Bauen → Validieren → Vorschau → Ausliefern in contributing.md. Kopierfertige Starter-Templates (Untertitel / VFX / Komponente / registry-item.json) finden Sie in templates.md.