Registro HyperFrames
O registro fornece blocos e componentes reutilizáveis instaláveis via hyperframes add <nome>.
- Blocos — subcomposições independentes (próprias dimensões, duração, timeline). Incluídos via
data-composition-srcem uma composição de host. - Componentes — trechos de efeitos (sem dimensões próprias). Colados diretamente no HTML da composição de host.
Quando usar esta habilidade
- O usuário menciona
hyperframes add, "bloco", "componente" ouhyperframes.json - A saída de
hyperframes addaparece na sessão (caminhos de arquivo, trecho na área de transferência) - Você precisa conectar um item instalado a uma composição existente
- Você deseja descobrir o que está disponível no registro
Referência rápida
hyperframes add data-chart # instalar um bloco
hyperframes add grain-overlay # instalar um componente
hyperframes add shimmer-sweep --dir . # direcionar um projeto específico
hyperframes add data-chart --json # saída legível por máquina
hyperframes add data-chart --no-clipboard # pular área de transferência (CI/headless)
Após a instalação, a CLI imprime quais arquivos foram escritos e um trecho para colar na sua composição de host. O trecho é um ponto de partida — você precisará adicionar os atributos data-composition-id (deve corresponder ao ID interno da composição do bloco), data-start e data-track-index ao conectar blocos.
Nota: hyperframes add funciona apenas para blocos e componentes. Para exemplos, use hyperframes init <dir> --example <nome> em vez disso.
Locais de instalação
Blocos são instalados em compositions/<nome>.html por padrão.
Componentes são instalados em compositions/components/<nome>.html por padrão.
Esses caminhos são configuráveis em hyperframes.json:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
Consulte install-locations.md para detalhes completos.
Conexão de blocos
Blocos são composições independentes — inclua-os via data-composition-src no seu index.html de host:
<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>
Atributos principais:
data-composition-src— caminho para o arquivo HTML do blocodata-composition-id— deve corresponder ao ID interno do blocodata-start— quando o bloco aparece na timeline do host (em segundos)data-duration— por quanto tempo o bloco é reproduzidodata-width/data-height— dimensões da tela do blocodata-track-index— ordem de camadas (maior valor = na frente)
Consulte wiring-blocks.md para detalhes completos.
Conexão de componentes
Componentes são trechos — cole seu HTML na marcação da sua composição, seu CSS no bloco de estilo e seu JavaScript no script (se houver):
- Leia o arquivo instalado (ex.:
compositions/components/grain-overlay.html) - Copie os elementos HTML para dentro do
<div data-composition-id="...">da sua composição - Copie o bloco
<style>para os estilos da sua composição - Copie qualquer conteúdo
<script>para o script da sua composição (antes do código da timeline) - Se o componente expuser integração com a timeline do GSAP (veja o bloco de comentários no trecho), adicione essas chamadas à sua timeline
Consulte wiring-components.md para detalhes completos.
Descoberta
Navegue pelos itens disponíveis:
# Leia o manifesto do registro
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Cada registry-item.json contém: nome, tipo, título, descrição, tags, dimensões (apenas blocos), duração (apenas blocos) e lista de arquivos.
Consulte discovery.md para detalhes sobre filtragem por tipo e tags.