HyperFrames 註冊表
註冊表提供可重複使用的區塊(Blocks)與元件(Components),可透過 hyperframes add <name> 安裝。
- 區塊 — 獨立的子組合(擁有自己的尺寸、時間長度、時間軸)。透過主組合中的
data-composition-src屬性引入。 - 元件 — 效果片段(無自訂尺寸)。直接貼入主組合的 HTML 中。
何時使用此技能
- 使用者提及
hyperframes add、「區塊」、「元件」或hyperframes.json hyperframes add的輸出出現在對話中(檔案路徑、剪貼簿片段)- 需要將已安裝項目整合至現有組合中
- 想要探索註冊表中有哪些項目可用
快速參考
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 會顯示已寫入的檔案以及一段可貼入主組合 HTML 的片段。該片段僅為起點 — 連結區塊時,您需要額外加入 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。
探索
瀏覽可用項目:
# 讀取註冊表清單
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
每個項目的 registry-item.json 包含:名稱、類型、標題、說明、標籤、尺寸(僅區塊)、時間長度(僅區塊)及檔案列表。
有關依類型與標籤篩選的詳細資訊,請參閱 discovery.md。