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 Abmessungen, Dauer, Zeitleiste). Werden über
data-composition-srcin eine Host-Komposition eingebunden. - Komponenten — Effekt-Snippets (keine eigenen Abmessungen). Werden direkt in das HTML einer Host-Komposition eingefügt.
Wann diese Fähigkeit verwendet werden sollte
- Der Benutzer erwähnt
hyperframes add, „Block“, „Komponente“ oderhyperframes.json - Die Ausgabe von
hyperframes adderscheint in der Sitzung (Dateipfade, Zwischenablage-Snippet) - Sie müssen ein installiertes Element in eine bestehende Komposition einbinden
- Sie möchten entdecken, was in der Registry verfügbar ist
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 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 hinzufügen, wenn Sie Blöcke verdrahten.
Hinweis: hyperframes add funktioniert nur für Blöcke und Komponenten. Für Beispiele verwenden Sie stattdessen hyperframes init <verzeichnis> --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"
}
}
Vollständige Details finden Sie in install-locations.md.
Verdrahtung 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 läuftdata-width/data-height— Block-Canvas-Abmessungendata-track-index— Ebenen-Reihenfolge (höher = weiter vorne)
Vollständige Details finden Sie in wiring-blocks.md.
Verdrahtung von Komponenten
Komponenten sind Snippets – fügen Sie ihr HTML in das Markup Ihrer Komposition, 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="...">der Komposition - Kopieren Sie den
<style>-Block in die Styles Ihrer Komposition - Kopieren Sie etwaige
<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 zu Ihrer Zeitleiste hinzu
Vollständige Details finden Sie in 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
Das registry-item.json jedes 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 in discovery.md.