Registre HyperFrames
Le registre fournit des blocs et composants réutilisables installables via hyperframes add <nom>.
- Blocs — sous-compositions autonomes (propres dimensions, durée, timeline). Inclus via
data-composition-srcdans une composition hôte. - Composants — extraits d'effets (sans dimensions propres). Collés directement dans le HTML d'une composition hôte.
Référence rapide
hyperframes add data-chart # installer un bloc
hyperframes add grain-overlay # installer un composant
hyperframes add shimmer-sweep --dir . # cibler un projet spécifique
hyperframes add data-chart --json # sortie lisible par machine
hyperframes add data-chart --no-clipboard # ignorer le presse-papiers (CI/sans tête)
Après l'installation, la CLI affiche les fichiers écrits et un extrait à coller dans votre composition hôte. L'extrait est un point de départ — vous devrez ajouter les attributs data-composition-id (doit correspondre à l'ID de composition interne du bloc), data-start et data-track-index lors du câblage des blocs.
Remarque : hyperframes add ne fonctionne que pour les blocs et composants. Pour les exemples, utilisez hyperframes init <répertoire> --example <nom> à la place.
Emplacements d'installation
Les blocs s'installent dans compositions/<nom>.html par défaut.
Les composants s'installent dans compositions/components/<nom>.html par défaut.
Ces chemins sont configurables dans hyperframes.json :
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
Voir install-locations.md pour tous les détails.
Câblage des blocs
Les blocs sont des compositions autonomes — incluez-les via data-composition-src dans votre index.html hôte :
<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>
Attributs clés :
data-composition-src— chemin vers le fichier HTML du blocdata-composition-id— doit correspondre à l'ID interne du blocdata-start— quand le bloc apparaît dans la timeline hôte (secondes)data-duration— durée de lecture du blocdata-width/data-height— dimensions du canevas du blocdata-track-index— ordre des couches (plus élevé = devant)
Voir wiring-blocks.md pour tous les détails.
Câblage des composants
Les composants sont des extraits — collez leur HTML dans le balisage de votre composition, leur CSS dans votre bloc de style, et leur JS dans votre script (le cas échéant) :
- Lisez le fichier installé (par exemple,
compositions/components/grain-overlay.html) - Copiez les éléments HTML dans la
<div data-composition-id="...">de votre composition - Copiez le bloc
<style>dans les styles de votre composition - Copiez tout contenu
<script>dans le script de votre composition (avant votre code de timeline) - Si le composant expose une intégration de timeline GSAP (voir le bloc de commentaire dans l'extrait), ajoutez ces appels à votre timeline
Voir wiring-components.md pour tous les détails.
Découverte
Parcourez les éléments disponibles :
# Lire le manifeste du registre
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Chaque élément registry-item.json contient : nom, type, titre, description, tags, dimensions (blocs uniquement), durée (blocs uniquement) et liste de fichiers.
Voir discovery.md pour plus de détails sur le filtrage par type et tags.
Contribuer à un nouveau bloc ou composant
Pour créer un NOUVEL élément de registre (style de légende, bloc VFX, transition, tiers inférieur, ou un composant réutilisable) et le livrer sous forme de PR amont — pas installer un existant — suivez le flux complet idée → échafaudage → construction → validation → prévisualisation → livraison dans contributing.md. Les modèles de démarrage prêts à copier-coller (légende / VFX / composant / registry-item.json) se trouvent dans templates.md.