HyperFrames Registry
注册表提供可通过 hyperframes add <name> 安装的可复用块和组件。
- 块 — 独立的子合成(拥有自己的尺寸、时长、时间线)。通过宿主合成中的
data-composition-src包含。 - 组件 — 效果片段(没有自己的尺寸)。直接粘贴到宿主合成的 HTML 中。
快速参考
hyperframes add data-chart # 安装一个块
hyperframes add grain-overlay # 安装一个组件
hyperframes add shimmer-sweep --dir . # 指定项目目录
hyperframes add data-chart --json # 机器可读输出
hyperframes add data-chart --no-clipboard # 跳过剪贴板(CI/无头环境)
安装后,CLI 会打印已写入的文件列表以及要粘贴到宿主合成中的片段。片段是起点 —— 接线块时,你需要添加 data-composition-id(必须与块的内部合成 ID 匹配)、data-start 和 data-track-index 属性。
注意:hyperframes add 仅适用于块和组件。对于示例,请改用 hyperframes init <dir> --example <name>。
安装位置
默认情况下,块安装到 compositions/<name>.html。
组件安装到 compositions/components/<name>.html。
这些路径可在 hyperframes.json 中配置:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
完整细节请参阅 install-locations.md。
接线块
块是独立的合成 —— 通过宿主 index.html 中的 data-composition-src 包含它们:
<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>
关键属性:
data-composition-src— 块 HTML 文件的路径data-composition-id— 必须与块的内部 ID 匹配data-start— 块在宿主时间线中出现的时间(秒)data-duration— 块播放的时长data-width/data-height— 块的画布尺寸data-track-index— 图层排序(值越大越靠前)
完整细节请参阅 wiring-blocks.md。
接线组件
组件是片段 —— 将其 HTML 粘贴到合成的标记中,CSS 粘贴到样式块中,JS(如果有)粘贴到脚本中:
- 读取已安装的文件(例如
compositions/components/grain-overlay.html) - 将 HTML 元素复制到合成的
<div data-composition-id="...">中 - 将
<style>块复制到合成的样式中 - 将任何
<script>内容复制到合成的脚本中(放在时间线代码之前) - 如果组件暴露了 GSAP 时间线集成(参见片段中的注释块),将这些调用添加到你的时间线中
完整细节请参阅 wiring-components.md。
发现
浏览可用项:
# 读取注册表清单
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
每个项的 registry-item.json 包含:name、type、title、description、tags、dimensions(仅块)、duration(仅块)和文件列表。
有关按类型和标签筛选的详细信息,请参阅 discovery.md。
贡献新的块或组件
要创作一个全新的注册表项(字幕样式、VFX 块、转场、下三分之一或可重复使用的组件)并将其作为上游 PR 提交 —— 而不是安装现有的 —— 请遵循完整的创意→脚手架→构建→验证→预览→PR 工作流,详见 contributing.md。可复制粘贴的启动模板(字幕 / VFX / 组件 / registry-item.json)位于 templates.md 中。