HyperFrames 注册表
注册表提供可通过 hyperframes add <name> 安装的可复用块和组件。
- 块 — 独立的子合成(有自己的尺寸、时长、时间线)。通过宿主合成中的
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 <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"
}
}
接入块
块是独立合成——通过在宿主 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 时间线集成(请参阅片段中的注释块),将这些调用添加到你的时间线中
发现
浏览可用项:
# 读取注册表清单
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 了解按类型和标签过滤的详细信息。