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). Eingebunden über
data-composition-srcin einer Host-Komposition. - Komponenten — Effekt-Schnipsel (keine eigenen Abmessungen). 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 . # In ein bestimmtes Projekt installieren
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 einen Schnipsel zum Einfügen in die Host-Komposition. Der Schnipsel 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>.
Installationspfade
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 alle Details.
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— Leinwandabmessungen des Blocksdata-track-index— Ebenenreihenfolge (höher = weiter vorne)
Siehe wiring-blocks.md für alle Details.
Komponenten verdrahten
Komponenten sind Schnipsel – fügen Sie ihr HTML in das Markup Ihrer Komposition, ihr CSS in den Style-Block und ihr JS in das 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 jeglichen
<script>-Inhalt in das Skript Ihrer Komposition (vor Ihrem Timeline-Code) - Wenn die Komponente eine GSAP-Timeline-Integration bereitstellt (siehe Kommentarblock im Schnipsel), fügen Sie diese Aufrufe zu Ihrer Timeline hinzu
Siehe wiring-components.md für alle Details.
Erkundung
Durchsuchen Sie verfügbare Elemente:
# Registry-Manifest lesen
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, Abmessungen (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Siehe discovery.md für Details zum Filtern nach Typ und Tags.
Einen neuen Block oder eine neue Komponente beitragen
Um ein NEUES Registry-Element (Bildunterschriftenstil, VFX-Block, Übergang, Lower Third oder eine wiederverwendbare Komponente) zu erstellen und als Upstream-PR zu veröffentlichen – nicht um ein vorhandenes zu installieren – folgen Sie dem vollständigen Workflow von der Idee über das Gerüst, den Bau, die Validierung, die Vorschau bis hin zum Versand in contributing.md. Kopierfertige Startvorlagen (Bildunterschrift/VFX/Komponente/registry-item.json) finden Sie in templates.md.