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 はブロックとコンポーネントに対してのみ機能します。例(examples)の場合は、代わりに 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ブロック、トランジション、ローワーサード、または再利用可能なコンポーネント)を作成し、それを上流のプルリクエストとして送信する場合(既存のアイテムをインストールするのではありません)、contributing.md に記載されたアイデア→スキャフォールド→ビルド→検証→プレビュー→出荷のワークフロー全体に従ってください。スターターテンプレート(キャプション / VFX / コンポーネント / registry-item.json)のコピー&ペースト用は templates.md にあります。