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