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 には、name、type、title、description、tags、dimensions(ブロックのみ)、duration(ブロックのみ)、およびファイルリストが含まれています。
タイプやタグによるフィルタリングの詳細は discovery.md を参照してください。
新しいブロックまたはコンポーネントのコントリビュート
新しいレジストリアイテム(キャプションスタイル、VFX ブロック、トランジション、ローワーサード、または再利用可能なコンポーネント)を作成し、上流への PR として送信するには(既存のものをインストールするのではなく)、contributing.md の完全なワークフロー(アイデア→スキャフォールド→ビルド→検証→プレビュー→送信)に従ってください。 スターターテンプレート(キャプション / VFX / コンポーネント / registry-item.json)のコピーペースト可能なものが templates.md にあります。