HyperFrames 註冊中心
註冊中心提供可透過 hyperframes add <名稱> 安裝的可重複使用區塊與元件。
- 區塊 — 獨立的子組合(擁有自己的尺寸、持續時間、時間軸)。透過
data-composition-src包含在主組合中。 - 元件 — 效果片段(沒有自己的尺寸)。直接貼入主組合的 HTML。
快速參考
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。
連接區塊
區塊是獨立的組合 — 透過 data-composition-src 包含在主 index.html 中:
<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。
貢獻新區塊或元件
要創建一個新的註冊項目(字幕樣式、VFX 區塊、轉場、下三分之一、或可重複使用的元件)並以向上游 PR 的形式發布 — 而不是安裝現有項目 — 請遵循 contributing.md 中的完整工作流程:構想 → 框架 → 構建 → 驗證 → 預覽 → 發布。複製貼上的入門範本(字幕 / VFX / 元件 / registry-item.json)可在 templates.md 中找到。