HyperFrames レジストリ
レジストリは、hyperframes add <name> でインストール可能な再利用可能なブロックとコンポーネントを提供します。
- ブロック — 独立したサブコンポジション(独自の寸法、期間、タイムラインを持ちます)。ホストコンポジション内で
data-composition-srcを介してインクルードします。 - コンポーネント — エフェクトスニペット(独自の寸法は持ちません)。ホストコンポジションのHTMLに直接貼り付けます。
このスキルを使用するタイミング
- ユーザーが
hyperframes add、「ブロック」、「コンポーネント」、またはhyperframes.jsonに言及した場合 hyperframes addの出力がセッションに表示された場合(ファイルパス、クリップボードスニペット)- インストールしたアイテムを既存のコンポジションに配線する必要がある場合
- レジストリで何が利用可能かを確認したい場合
クイックリファレンス
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 を参照してください。