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ブロック、トランジション、ローワーサード、または再利用可能なコンポーネント)を作成し、上流へのプルリクエストとして公開するには — 既存のものをインストールするのではなく — contributing.md の完全なワークフロー(アイデア→雛形作成→構築→検証→プレビュー→公開)に従ってください。スターターテンプレート(キャプション / VFX / コンポーネント / registry-item.json)のコピーペースト用は templates.md にあります。