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 を参照してください。