HyperFrames 注册表
注册表提供可复用的块和组件,可通过 hyperframes add <名称> 安装。
- 块 — 独立的子合成(拥有自己的尺寸、时长、时间线)。通过宿主合成中的
data-composition-src引入。 - 组件 — 效果代码段(无独立尺寸)。直接粘贴到宿主合成的 HTML 中。
何时使用本技能
- 用户提到
hyperframes add、"块"、"组件" 或hyperframes.json hyperframes add的输出出现在会话中(文件路径、剪贴板片段)- 你需要将已安装项接入现有合成
- 你想发现注册表中可用的项
快速参考
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 <目录> --example <名称>。
安装位置
默认情况下,块安装在 compositions/<名称>.html。
默认情况下,组件安装在 compositions/components/<名称>.html。
这些路径可在 hyperframes.json 中配置:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
接入块
块是独立的合成——通过 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 粘贴到合成的标记中,样式粘贴到样式块中,JS 粘贴到脚本中(如果有的话):
- 读取安装的文件(例如
compositions/components/grain-overlay.html) - 将 HTML 元素复制到合成的
<div data-composition-id="...">中 - 将
<style>块复制到合成的样式中 - 将任何
<script>内容复制到合成的脚本中(放在时间线代码之前) - 如果组件提供了 GSAP 时间线集成(见代码段中的注释块),将这些调用添加到你的时间线中
发现
浏览可用项:
# 读取注册表清单
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
每个项的 registry-item.json 包含:名称、类型、标题、描述、标签、尺寸(仅块)、时长(仅块)和文件列表。
详见 discovery.md 了解按类型和标签筛选的细节。