文件

自訂Sidekick

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

您可以自訂專案的Sidekick。 您可以新增 /tools/sidekick/config.json 設定檔案至您專案的GitHub存放庫：

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

如需所有可用的組態選項，請參閱 Sidekick API檔案 或 設定結構描述. 以下是開始使用的一些基本知識：

外掛程式

  • id 和 title 為必填欄位。 title 將會顯示於外掛程式按鈕上。 您可以提供以下內容的本地化標題： titleI18n 物件
  • 如何指定外掛程式動作取決於意圖：
    • 若要在新視窗中開啟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>
  • 此 environments array會指定外掛程式應該出現的位置（dev、edit、admin、preview、live或prod）。 您也可以定義 exclude_paths 和 include_paths 陣列，用來根據路徑縮小外掛程式的外觀。
  • isContainer 將外掛程式轉換為下拉式清單。 接著，您可以在中指定其ID，以新增其他外掛程式 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>
  • 開啟符合設定的專案URL path 然後按一下sidekick ，檢視您的檢視器運作中。
recommendation-more-help
10a6ce9d-c5c5-48d9-8ce1-9797d2f0f3ec