HyperFrames 註冊中心
註冊中心提供可透過 hyperframes add <名稱> 安裝的可重用區塊和元件。
- 區塊(Blocks) — 獨立的子組合(擁有自己的尺寸、時長、時間軸)。在主機組合中以
data-composition-src屬性引入。 - 元件(Components) — 效果片段(無獨立尺寸)。直接貼入主機組合的 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 <目錄> --example <名稱>。
安裝位置
區塊預設安裝至 compositions/<名稱>.html。
元件預設安裝至 compositions/components/<名稱>.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。