HyperFrames 核心指南
HyperFrames 通过 HTML 渲染视频。组合是一个 HTML 文件,其 DOM 使用 data-* 属性声明时间线,动画运行时是可寻址的,并且媒体播放由框架拥有。
本技能是技术契约——即如何构建一个 HyperFrames 项目。以下内容是构建指南;每个主题的详细信息位于 references/(索引见下文),按需阅读。其他关注点位于相关的领域技能中——hyperframes-animation、hyperframes-creative、hyperframes-media、hyperframes-cli、hyperframes-registry。能力映射在 /hyperframes 中说明每个技能覆盖的内容。
参考文档
| 文件 | 阅读目的… |
|---|---|
references/minimal-composition.md | 从最小的可渲染组合骨架开始 |
references/composition-patterns.md | 选择整体式 vs 模块化;设计模块化 index.html;选择子组合原型 |
references/data-attributes.md | 查阅任何 data-*(根元素/片段/子组合宿主/旧别名);使用 class="clip" |
references/tracks-and-clips.md | 选择 data-track-index;处理同轨道重叠/层级;使一个片段相对于另一个片段计时 |
references/sub-compositions.md | 连接子组合(宿主属性、<template>、实例变量)并在其内部制作动画 |
references/variables-and-media.md | 声明变量;放置 <video>/<audio>;设置音量;裁剪 |
references/determinism-rules.md | 构建可寻址时间线;确定性禁止规则;可动画属性白名单;布局/文本适配 |
references/full-screen-motion.md | 制作全屏运动,使用共享背景 |
references/storyboard-format.md | 编写 STORYBOARD.md 计划(加上解析后的清单) |
references/script-format.md | 编写可选的 SCRIPT.md 锁定旁白 |
references/subagent-dispatch.md | 将子代理调度动词(并行扇出/后台/等待)映射到你的流程 |
references/tailwind.md | 在 Tailwind v4 项目中工作(init --tailwind;运行时契约与 Studio 的 v3 不同) |
有关动画运行时细节(GSAP API、Lottie、Three.js 等),请参阅 hyperframes-animation → adapters/<runtime>.md。
构建组合
两种根形式(不可互换)
- 独立式(顶层
index.html)——根元素<div data-composition-id="…">直接位于<body>中,无<template>包装(包装它会隐藏所有内容并破坏渲染)。 - 子组合(通过
data-composition-src加载)——根元素必须用<template>包装。
⚠ 传输规则:运行时仅克隆
<template>内容;外部的一切(包括<head>样式/脚本)将被丢弃——请将<style>/<script>放在模板内部。 ⚠ 宿主 ID 规则:宿主插槽的data-composition-id必须完全等于内部模板的data-composition-id以及window.__timelines["<id>"]键——不添加-mount/-slot/-host后缀。
文件结构、宿主连接和渲染前检查清单 → references/sub-compositions.md。
根元素必须设置尺寸(静默布局 bug)
独立式根元素需要一个显式的尺寸盒子(宽/高以像素为单位),并且每个向下传递到 height:100% 元素的祖先都必须有一个已解析的高度——否则 flex/100% 的子元素会坍缩到约 0,内容会堆积在左上角。lint/validate/inspect 均不会捕获此问题。骨架 → references/minimal-composition.md。
一个暂停的时间线
每个组合在页面加载时同步注册恰好一个 gsap.timeline({ paused: true }) 在 window.__timelines["<id>"](键 = 根元素 data-composition-id),渲染时长 = 根元素 data-duration,而不是时间线的长度。不要手动将子时间线嵌套到宿主中。完整契约(包括非 GSAP 运行时)→ references/determinism-rules.md + hyperframes-animation/adapters/。
强制性规则(lint/validate/inspect 不会捕获的静默 bug)
在此列出;完整原理请参阅链接的参考文档。不得违反:
- 无渲染时时钟/未设置种子的
Math.random/网络/输入状态;无repeat: -1(请使用有限次数)。→determinism-rules.md - 仅动画化视觉属性白名单中的属性;永远不要使用
display/visibility;不要对后续场景的片段使用gsap.set。→determinism-rules.md - 正文文本中无
<br>;已转换的元素必须为块级并设置尺寸;脉冲式绝对定位装饰元素需要峰值间隙。→determinism-rules.md <video>/<audio>必须是宿主根元素的直接子元素(永远不要放在子组合<template>/包装器内);框架拥有播放控制权。→variables-and-media.md- 每个
id必须在整个组装后的页面中唯一;在子组合内部,为 id 添加组合 id 前缀(#<id>-hero)。重复的<video>/<img>id 会导致渲染空白——生产者通过getElementById注入帧,跨文件的重复会绕过lint。→composition-patterns.md - 全屏场景填充必须放在全出血的子元素上(
position:absolute; inset:0),切勿放在组合根元素本身上——生产者的帧合成可能会丢弃根元素自身的background(帧渲染为黑色),即使预览/snapshot显示正确。→composition-patterns.md
编辑现有组合
- 首先读取文件。保留无关的时间、轨道、ID、变量、媒体路径。
- 匹配现有的组合 ID 和时间线键。
- 添加片段:选择一个非重叠的
data-track-index或有意识地调整周围的时间。 - 添加子组合:在连接宿主之前验证其内部的
data-composition-id。
验证
使用 hyperframes-cli 获取命令详情
-
npx hyperframes lint通过(0 错误) -
npx hyperframes validate通过(0 控制台错误) -
npx hyperframes inspect通过(0 错误) - 包含子组合的项目:
npx hyperframes snapshot --at <midpoints>并目视检查每一帧 -
npx hyperframes preview用于审查(用户可以在 Studio 的时间线中编辑任何内容) - 仅在用户批准后运行
npx hyperframes render