HyperFrames Registrierung
Die Registrierung bietet wiederverwendbare Blöcke und Komponenten, 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.
Kurzreferenz
hyperframes add data-chart # einen Block installieren
hyperframes add grain-overlay # eine Komponente installieren
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 zum Einfügen in Ihre Host-Komposition. Das Snippet ist ein Ausgangspunkt – Sie müssen data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index beim Einbinden 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 installieren standardmäßig nach compositions/<name>.html.
Komponenten installieren standardmäßig nach compositions/components/<name>.html.
Diese Pfade können in hyperframes.json konfiguriert werden:
{
"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.
Blöcke einbinden
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— Block-Leinwandabmessungendata-track-index— Ebenenreihenfolge (höher = weiter vorne)
Siehe wiring-blocks.md für vollständige Details.
Komponenten einbinden
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 (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 den Kommentarblock im Snippet), fügen Sie diese Aufrufe zu Ihrer Zeitleiste hinzu
Siehe wiring-components.md für vollständige Details.
Suche
Durchsuchen Sie verfügbare Elemente:
# Registrierungsmanifest 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 Registrierungselement zu erstellen (Stil einer Bildunterschrift, VFX-Block, Übergang, unteres Drittel oder eine wiederverwendbare Komponente) und es als Upstream-PR zu versenden – nicht ein vorhandenes zu installieren – befolgen Sie den vollständigen Workflow von Idee → Gerüst → erstellen → validieren → Vorschau → versenden in contributing.md. Kopierfertige Startvorlagen (Bildunterschrift / VFX / Komponente / registry-item.json) finden Sie in templates.md.