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 — snippets d'effets (pas de 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/headless)
Après l'installation, le CLI affiche les fichiers écrits et un snippet à coller dans votre composition hôte. Le snippet 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 fonctionne uniquement pour les blocs et composants. Pour les exemples, utilisez plutôt hyperframes init <dossier> --example <nom>.
Emplacements d'installation
Les blocs s'installent par défaut dans compositions/<nom>.html.
Les composants s'installent par défaut dans compositions/components/<nom>.html.
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 snippets — 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 votre
<div data-composition-id="..."> - 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 timeline GSAP (voir le bloc de commentaire dans le snippet), 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 registry-item.json contient : nom, type, titre, description, tags, dimensions (blocs uniquement), durée (blocs uniquement), et liste de fichiers.
Voir discovery.md pour le filtrage par type et tags.
Contribuer avec 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 soumettre sous forme de PR amont — et non installer un élément existant — suivez le workflow complet idée → échafaudage → construction → validation → prévisualisation → publication dans contributing.md. Des modèles de démarrage à copier-coller (légende / VFX / composant / registry-item.json) se trouvent dans templates.md.