HyperFrames Registry
Die Registry stellt wiederverwendbare Blöcke und Komponenten bereit, die über hyperframes add <name> installiert werden.
- Blöcke — eigenständige Unterkompositionen (eigene Abmessungen, Dauer, Zeitleiste). Werden mittels
data-composition-srcin eine Host-Komposition eingebunden. - Komponenten — Effekt-Schnipsel (ohne eigene 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 einen Ausschnitt zum Einfügen in deine Host-Komposition. Der Ausschnitt ist ein Ausgangspunkt – du musst die Attribute data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index hinzufügen, wenn du Blöcke einbindest.
Hinweis: hyperframes add funktioniert nur für Blöcke und Komponenten. Für Beispiele verwende 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 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 – binde sie über data-composition-src in deine 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.
Komponenten einbinden
Komponenten sind Schnipsel – füge ihr HTML in das Markup deiner Komposition ein, ihr CSS in deinen Style-Block und ihr JS in dein Skript (falls vorhanden):
- Lese die installierte Datei (z. B.
compositions/components/grain-overlay.html) - Kopiere die HTML-Elemente in das
<div data-composition-id="...">deiner Komposition - Kopiere den
<style>-Block in die Styles deiner Komposition - Kopiere jeglichen
<script>-Inhalt in das Skript deiner Komposition (vor deinem Zeitleisten-Code) - Falls die Komponente eine GSAP-Zeitleisten-Integration bereitstellt (siehe Kommentarbereich im Schnipsel), füge diese Aufrufe zu deiner Zeitleiste hinzu
Siehe wiring-components.md für vollständige Details.
Erkundung
Durchsuche verfügbare Elemente:
# Das 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 beisteuern
Um ein NEUES Registry-Element (Caption-Stil, VFX-Block, Übergang, Lower Third oder eine wiederverwendbare Komponente) zu erstellen und als Upstream-PR einzureichen – nicht ein bestehendes zu installieren – folge dem vollständigen Workflow von Idee über Gerüstbau, Erstellung, Validierung, Vorschau bis zum Versand in contributing.md. Kopierfertige Startvorlagen (Caption / VFX / Komponente / registry-item.json) findest du in templates.md.