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, linha do tempo). Incluídos via
data-composition-srcem uma composição hospedeira. - Componentes — trechos de efeito (sem dimensões próprias). Colados diretamente no HTML de uma composição hospedeira.
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 gravados e um snippet para colar em sua composição hospedeira. O snippet é um ponto de partida — você precisará adicionar os atributos data-composition-id (deve corresponder ao ID de composição interno do bloco), data-start e data-track-index ao conectar blocos.
Observação: hyperframes add funciona apenas para blocos e componentes. Para exemplos, use hyperframes init <dir> --example <nome>.
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 no 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.
Conectando blocos
Blocos são composições independentes — inclua-os via data-composition-src no seu index.html hospedeiro:
<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 linha do tempo hospedeira (segundos)data-duration— por quanto tempo o bloco é reproduzidodata-width/data-height— dimensões da tela do blocodata-track-index— ordem das camadas (maior = à frente)
Consulte wiring-blocks.md para detalhes completos.
Conectando componentes
Componentes são trechos — cole seu HTML na marcação da sua composição, seu CSS no bloco de estilos e seu JS no script (se houver):
- Leia o arquivo instalado (ex.:
compositions/components/grain-overlay.html) - Copie os elementos HTML para dentro da
<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 linha do tempo) - Se o componente expuser integração com a linha do tempo do GSAP (veja o bloco de comentário no snippet), adicione essas chamadas à sua linha do tempo
Consulte wiring-components.md para detalhes completos.
Descoberta
Navegue pelos itens disponíveis:
# Ler 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.
Contribuindo com um novo bloco ou componente
Para criar um NOVO item do registro (estilo de legenda, bloco VFX, transição, terço inferior ou um componente reutilizável) e enviá-lo como um PR para o repositório upstream — e não instalar um existente — siga o fluxo completo de ideia → esqueleto → construção → validação → pré-visualização → envio descrito em contributing.md. Modelos iniciais prontos para copiar e colar (legenda / VFX / componente / registry-item.json) estão em templates.md.