用途 hyperframes-registry 是 HyperFrames 体系中的注册表技能,核心用途是让使用者在手工构建具名视觉效果之前,先搜索、安装并接入注册表中已有的区块与组件。资料指出,当简报或用户需求涉及某个具名视觉时,应优先使用本技能查找现成条目。
主要能力 注册表提供两类可安装条目:区块(Blocks)是独立子合成,拥有自己的尺寸、时长与时间线,通过 data-composition-src 被宿主合成引入;组件(Components)是效果片段,没有独立尺寸,直接粘贴进宿主合成的 HTML。安装通过 hyperframes add <name> 完成,位置参数优先按精确条目名解析,若无匹配且该值为标签,则安装所有带该标签的区块;注册表依赖会先于所请求条目安装。
安装命令示例包括:hyperframes add data-chart(安装区块)、hyperframes add grain-overlay(安装组件)、hyperframes add captions(安装所有带 captions 标签的区块)、hyperframes add shimmer-sweep --dir .(指定项目目录)、--json(机器可读输出)、--no-clipboard(跳过剪贴板,适用于 CI 或无头环境)。安装后 CLI 会打印写入的文件及可粘贴进宿主合成的代码片段。区块默认安装到 compositions/<name>.html,组件默认安装到 compositions/components/<name>.html,路径可在 hyperframes.json 的 paths 中配置。
接线方式上,区块在宿主 index.html 中通过 div 引入,需设置 data-composition-src、data-composition-id(须与区块内部 ID 一致)、data-start、data-duration、data-width/data-height,data-track-index 仅用于 Studio 时间线显示,层叠应使用 CSS z-index。组件则需将其 HTML 复制进宿主合成的容器,CSS 复制进样式块,JS 复制进脚本(位于时间线代码之前),若组件提供 GSAP 时间线集成,还需按注释块添加调用。
检索与发现 CLI 是主要发现入口。可用 npx hyperframes catalog --query "..." 按意图检索,搜索默认在本地进行、不发送数据;默认按与条目名称、标题、描述共享的词汇排序,--on-device 则需一次性下载模型后按语义排序,--json 会标明由哪一层返回结果。查询应使用英文,即使视频本身是其他语言;非英文查询不会产生可检索词而返回空结果,并提示 No searchable words in query。也可用 catalog 配合 --type block/component、--tag、--json、--human-friendly 浏览或筛选;--human-friendly 为交互式选择并立即安装,CI 或智能体流程中建议先 --json 再显式 add。
缺口反馈 当检索结果无法满足需求时,应在手工编写效果前报告:npx hyperframes feedback --search-miss "<查询>" --wanted "<所需效果>" --tier <层>。catalog --query 会预填该行,--json 以 report_gap 携带。无论哪一层,只要结果不满足都应报告,不必等待需经同意下载 33 MB 的 on-device 层。报告应描述想要的效果而非想象中的条目名。这是唯一会向外发送查询的路径,且不计入评分指标。
限制与注意事项 若 CLI 无法连接配置的注册表,可回退查看原始清单 registry.json;清单有 24 小时刷新窗口,重新校验失败时仍使用磁盘上的上一份副本,因此 catalog 与 catalog --query 仍可检索排序。但 add 即使对昨日安装过的条目也需要网络,只有清单被缓存,条目文件每次安装都会重新获取,故不能承诺离线安装。每个条目的 registry-item.json 包含 name、type、title、description、tags、dimensions(仅区块)、duration(仅区块)和文件列表。hyperframes add 仅适用于区块与组件;示例应使用 hyperframes init <dir> --example <name>。若要作为上游 PR 贡献新的注册表条目,需按 contributing.md 的构思、脚手架、构建、验证、预览、交付流程操作,模板见 templates.md。插件安装场景下,在执行设置或新鲜度命令前应遵循插件执行规则。