HyperFrames 注册表
注册表提供可复用的块和组件,通过 hyperframes add <name> 安装。
- 块(Blocks) — 独立子编排(拥有自己的尺寸、时长、时间线)。通过宿主编排中的
data-composition-src属性引入。 - 组件(Components) — 特效片段(没有自己的尺寸)。直接粘贴到宿主编排的 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"
}
}
接入块
块是独立的编排——通过宿主 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 包含:名称、类型、标题、描述、标签、尺寸(仅块)、时长(仅块)以及文件列表。
详见 discovery.md 了解如何按类型和标签筛选。
贡献新的块或组件
要编写一个新的注册表项(字幕样式、VFX 块、过渡、底部三分之一或可复用组件)并将其作为上游 PR 发布——而非安装现有项——请遵循 contributing.md 中完整的构思 → 搭建 → 构建 → 验证 → 预览 → 发布工作流。启动模板(字幕 / VFX / 组件 / registry-item.json)可在 templates.md 中找到。