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 には、name、type、title、description、tags、dimensions(ブロックのみ)、duration(ブロックのみ)、file list が含まれています。
タイプとタグによるフィルタリングの詳細は discovery.md を参照してください。