HyperFrames 註冊表
註冊表提供可透過 hyperframes add <name> 安裝的區塊與元件。
- 區塊 — 獨立的子組合(擁有自己的尺寸、時長與時間軸)。在主組合中透過
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 <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 以了解如何依類型和標籤進行篩選。
貢獻新的區塊或元件
若要創作一個全新的註冊表項目(字幕樣式、VFX 區塊、轉場、下三分之一疊加層,或可重複使用的元件)並以 Pull Request 提交至上游,而非安裝現有項目——請遵循完整的「構想 → 搭建 → 建置 → 驗證 → 預覽 → 發送」工作流程,詳見 contributing.md。入門範本(字幕 / VFX / 元件 / registry-item.json)位於 templates.md。