HyperFrames 註冊表
註冊表提供可透過 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 會列印出已寫入的檔案以及要貼入主組合的程式碼片段。該片段只是一個起點——接入區塊時,你需要添加 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,了解如何按類型和標籤進行篩選。