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,處理相同時間軸重疊 / 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/<執行環境>.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 <中點>並目視檢查每個幀 -
npx hyperframes preview用於審查(使用者可以在 Studio 的時間軸中編輯任何內容) - 僅在使用者批准後才
npx hyperframes render