HyperFrames レジストリ
レジストリは、hyperframes add <名前> でインストール可能な再利用可能なブロックとコンポーネントを提供します。
- ブロック — 独立したサブコンポジション(独自の寸法、持続時間、タイムラインを持ちます)。ホストコンポジション内で
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 <名前> を使用してください。
インストール場所
ブロックはデフォルトで compositions/<名前>.html にインストールされます。
コンポーネントはデフォルトで compositions/components/<名前>.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ブロック、トランジション、ローワーサード、または再利用可能なコンポーネント)を作成し、上流にPRとして送信するには、contributing.md にある完全なアイデア→スキャフォールド→ビルド→検証→プレビュー→出荷のワークフローに従ってください。コピーペースト可能なスターターテンプレート(キャプション / VFX / コンポーネント / registry-item.json)は templates.md にあります。