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 (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 captions # installer tous les blocs tagués 'captions'
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-papier (CI/headless)
Après l'installation, le 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 interne de la composition du bloc), data-start, et data-track-index lors du branchement des blocs.
La valeur positionnelle est d'abord résolue comme un nom d'élément exact. Si aucun élément ne correspond et que la valeur est un tag, la commande installe tous les blocs avec ce tag. Les dépendances du registre sont installées avant l'élément demandé. 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 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.
Branchement de 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 canvas du blocdata-track-index— ordre des couches (plus élevé = devant)
Voir wiring-blocks.md pour tous les détails.
Branchement de 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 le
<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
Utilisez le CLI comme principale interface de découverte. Recherchez par intention avant de parcourir : le registre contient plus d'éléments que vous ne pouvez en parcourir manuellement, donc les lister et faire correspondre les noms ou tags est la voie lente, et elle échoue chaque fois que le vocabulaire de l'auteur diffère du vôtre.
# Classez l'ensemble du catalogue par rapport à ce que le beat doit faire
npx hyperframes catalog --query "révéler un titre ligne par ligne"
npx hyperframes add caption-clip-wipe
La recherche est locale et n'envoie rien. Par défaut, elle classe en fonction du vocabulaire partagé avec le nom, le titre et la description de l'élément, donc elle ne trouve que les éléments qui réutilisent vos mots ; --on-device classe par sens à la place, après un téléchargement unique du modèle. Avec --json, l'enveloppe indique quel niveau a répondu, donc vérifiez cela plutôt que de supposer qu'un classement a eu lieu.
L'installabilité est appliquée après le classement, pas avant : un nom que les vecteurs transportent mais que ce registre ne peut pas servir est retiré des résultats et compté dans dropped, donc un dropped non nul signifie que les deux sont de générations différentes. Voir /hyperframes-cli pour le niveau hors ligne, les portes de consentement, et comment rafraîchir un index obsolète.
Pour parcourir ou filtrer au lieu de rechercher :
npx hyperframes catalog
npx hyperframes catalog --type block
npx hyperframes catalog --type component
npx hyperframes catalog --type block --tag social
npx hyperframes catalog --json
npx hyperframes catalog --human-friendly
Le mode tableau normal et le mode --json listent uniquement les correspondances ; installez un nom sélectionné avec hyperframes add <nom>. --human-friendly ouvre un sélecteur interactif et installe l'élément sélectionné immédiatement. Dans les workflows CI ou agent, préférez --json suivi d'un add explicite.
Si le CLI ne peut pas atteindre le registre configuré, inspectez le manifeste brut comme solution de repli :
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Le registry-item.json de chaque élément contient : nom, type, titre, description, tags, dimensions (blocs uniquement), durée (blocs uniquement), et liste de fichiers.
Voir discovery.md pour les détails sur le filtrage par type et tags.
Contribuer un nouveau bloc ou composant
Pour créer un NOUVEL élément du registre (style de légende, bloc VFX, transition, tiers inférieur, ou composant réutilisable) et le soumettre sous forme de PR en amont — et non pas installer un élément existant — suivez le workflow complet idée → échafaudage → construction → validation → prévisualisation → livraison dans contributing.md. Des modèles de démarrage copiables (légende / VFX / composant / registry-item.json) se trouvent dans templates.md.