HyperFrames 注册表
注册表提供了可通过 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。
接线块
块是独立的合成——通过 data-composition-src 在宿主 index.html 中引入:
<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 包含:名称、类型、标题、描述、标签、尺寸(仅块)、时长(仅块)和文件列表。
有关按类型和标签筛选的详细信息,请参阅 discovery.md。
贡献新的块或组件
要创作新的注册表项目(字幕样式、VFX 块、过渡、下方三分之一或可复用组件)并将其作为上游 PR 发布——而不是安装现有的项目——请按照 contributing.md 中的完整创意→脚手架→构建→验证→预览→发布工作流进行。启动模板(字幕/VFX/组件/registry-item.json)可在 templates.md 中找到。