HyperFrames レジストリ
レジストリは、hyperframes add <name> でインストール可能な再利用可能なブロックとコンポーネントを提供します。
- ブロック — 独立したサブコンポジション(独自の寸法、再生時間、タイムラインを持つ)。ホストコンポジション内で
data-composition-srcを使用してインクルードします。 - コンポーネント — エフェクトスニペット(独自の寸法は持たない)。ホストコンポジションの HTML に直接貼り付けます。
このスキルを使うタイミング
- ユーザーが
hyperframes add、"block"、"component"、または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) - コンポジションの
<div data-composition-id="...">内に HTML 要素をコピーする <style>ブロックをコンポジションのスタイルにコピーする<script>の内容をコンポジションのスクリプトにコピーする(タイムラインコードの前に)- コンポーネントが GSAP タイムライン統合を公開している場合(スニペット内のコメントブロックを参照)、それらの呼び出しをタイムラインに追加する
詳細は wiring-components.md を参照してください。
ディスカバリー
利用可能なアイテムを参照する:
# レジストリマニフェストを読む
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
各アイテムの registry-item.json には、名前、種類、タイトル、説明、タグ、寸法(ブロックのみ)、再生時間(ブロックのみ)、ファイル一覧が含まれています。
種類とタグによるフィルタリングの詳細は discovery.md を参照してください。