HyperFrames Registry
Registry 提供可透過 hyperframes add <name> 安裝的可重複使用區塊與元件。
- 區塊 (Blocks) — 獨立的子組合(擁有自己的尺寸、持續時間、時間軸)。在主組合中透過
data-composition-src引入。 - 元件 (Components) — 效果片段(無自身尺寸)。直接貼入主組合的 HTML 中。
何時使用此技能
- 使用者提及
hyperframes add、"block"、"component" 或hyperframes.json hyperframes add的輸出出現在對話中(檔案路徑、剪貼簿片段)- 你需要將安裝的項目接入現有組合
- 你想探索 Registry 中有哪些可用項目
快速參考
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。
探索
瀏覽可用項目:
# 讀取 registry 清單
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
每個項目的 registry-item.json 包含:名稱、類型、標題、描述、標籤、尺寸(僅區塊)、持續時間(僅區塊)以及檔案清單。
關於依類型與標籤篩選的詳細資訊,請參考 discovery.md。