HyperFrames 核心技術契約 是做什麼的?
HyperFrames 透過 HTML 渲染影片。一個組合就是一個 HTML 檔案,其 DOM 透過 data-* 屬性宣告時間,其動畫執行時期是可定位的(seekable),且媒體播放由框架所擁有。
此技能是技術合約 — 說明如何建立一個 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,處理同軌道重疊 / z-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。
根必須設定尺寸(無聲的版面錯誤)
獨立的根需要一個明確的尺寸盒子(以 px 為單位的 width/height),並且直到一個 height:100% 元素為止的每個祖先都必須具有已解析的高度 — 否則 flex / 100% 的子元素會收縮到接近 0,導致內容堆疊在左上角。lint/validate/inspect 不會捕捉到這個問題。骨架 → references/minimal-composition.md。
一個暫停的時間軸
每個組合在 window.__timelines["<id>"](鍵 = 根的 data-composition-id)註冊剛好一個 gsap.timeline({ paused: true }),並在頁面載入時同步建立。渲染持續時間 = 根的 data-duration,而不是時間軸長度。請勿手動將子時間軸巢狀嵌入到宿主中。完整合約(包含非 GSAP 執行時期)→ references/determinism-rules.md + hyperframes-animation/adapters/。
不可協商的規則(lint/validate/inspect 不會捕捉的無聲錯誤)
在此列出;完整理由請參閱連結的參考資料。請勿違反:
- 無渲染時間時鐘 / 未種子化的
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