HyperFrames 注册表
注册表提供了可通过 hyperframes add <name> 安装的可复用块和组件。
- 块 (Blocks) — 独立的子组合(拥有自己的尺寸、时长和时间线)。通过宿主组合中的
data-composition-src属性引入。 - 组件 (Components) — 效果代码片段(没有自己的尺寸)。直接粘贴到宿主组合的 HTML 中。
何时使用此技能
- 用户提及
hyperframes add、"block"、"component" 或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"
}
}
详情请参见 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 包含:名称、类型、标题、描述、标签、尺寸(仅限块)、时长(仅限块)以及文件列表。
详情请参见 discovery.md,了解按类型和标签进行过滤的信息。