ドキュメント

Sidekickのカスタマイズ

Last update: Tue Mar 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

プロジェクトのサイドキックをカスタマイズできます。 次の項目を追加できます： /tools/sidekick/config.json 設定ファイルをプロジェクトの GitHub リポジトリに保存します。

<script src=“https://gist.github.com/rofe/491772e7e3f706cb4aca5f9f6451e516.js”></script>

使用可能なすべての設定オプションについては、 SidekickAPI ドキュメント または 設定スキーマ. 基本事項を以下に示します。

プラグイン

  • id および title は必須です。 title がプラグインボタンに表示されます。 ローカライズされたタイトルを titleI18n object
  • プラグインアクションの指定方法は、インテントによって異なります。
    • URL を新しいウィンドウで開くだけで、 url プロパティ。 オプションで、を設定することで、パレットで開かせることができます isPalette から true.
      /tools/sidekick/config.json:
      <script src=“https://gist.github.com/rofe/8a0961575d434fb86ce4fdda3bea60f5.js”></script>
  • コードの実行は、ページのコンテキストでおこなう必要があります（編集および管理環境ではサポートされていません）。 以下を使用すると、 event プロパティを使用して、プラグインボタンがクリックされたときに実行されるイベントの名前を指定します。 その後、次の例のように、アプリケーションコード内でこれに対応できます。
    /tools/sidekick/config.json:
    <script src=“https://gist.github.com/rofe/e5f215be84acc51ffe87002408d4e107.js”></script>
    <script src=“https://gist.github.com/rofe/4d38d9ec8253cc2f4bec3dad757c33fc.js”></script>
  • The environments 配列は、プラグインを表示する場所を指定します (dev、edit、admin、preview、live、prod)。 また、 exclude_paths および include_paths 配列を使用して、パスに基づいてプラグインの外観を絞り込みます。
  • isContainer プラグインをドロップダウンに変換します。 その後、 containerId プロパティ。
  • override に設定できます。 true 既存のプラグインを拡張する。

特殊ビュー

  • path および viewer は必須です。 必要に応じて、 title 上部に表示され、 titleI18n オブジェクト：
    <script src=“https://gist.github.com/rofe/9170d068a7b3ab727a8745774e430aca.js”></script>
  • で設定したHTMLファイルを追加します。 path をプロジェクトの GitHub リポジトリに追加します。
    <script src=“https://gist.github.com/rofe/0de48b1696c7334f6fdbd9f63993aad2.js”></script>
  • オプションの CSS ファイルを同じディレクトリに追加し、ロジックを含んだ JS ファイルを追加します。
    <script src=“https://gist.github.com/rofe/8357f72407683cf4bd27c5d364b71af7.js”></script>
  • 設定した path サイドキックをクリックして、実際のビューアを表示します。
recommendation-more-help
10a6ce9d-c5c5-48d9-8ce1-9797d2f0f3ec