在編輯器工具列中新增自訂可操作的按鈕
在本文中,我們將瞭解如何在編輯器工具列中新增自訂按鈕,並呼叫javascript以執行所需的自訂操作。
將可操作的按鈕新增至網路編輯器涉及以下步驟:
- 在中新增按鈕 ui_config.json 在需要的位置
- 在瀏覽器中註冊按一下按鈕的事件,讓使用者在按一下按鈕時執行動作
以範例來實施
以作者想要將jira參考新增至主題序號區段的範例來瞭解此情況。 包含內嵌jira reference-id的prolog區段可能如下所示:
包含JIRA ID的「change-request-id」元素應從API中擷取(比方說,根據應用程式描述的特定JIRA查詢)。 當使用者編寫prolog區段時,使用者應該能夠按一下按鈕並從網頁編輯器工具列插入jira參考id,例如:
當使用者按一下按鈕時,應該會顯示對話方塊,其中應提取可能的選項,並允許使用者選取所需的JIRA ID,例如:
然後應將「change-request-id」新增至prolog:
實作此
將按鈕設定在,以新增至Webitor ui_config.json
使用資料夾設定檔來檢查 ui_config.json 在「XML編輯器設定」索引標籤下,將按鈕設定JSON新增到「工具列」群組的所需區段中
{
"on-click":"insertJIRARef",
"icon":"linkCheck",
"variant":"quiet",
"type":"button",
"title":"Insert JIRA Reference"
}
使用此連結來進一步瞭解資料夾設定檔和設定ui_config.json
處理新按鈕的點按事件
注意:以下提及的步驟可作為此貼文附加的套件提供
- 儲存資料夾設定檔後,請在專案目錄(可能位於 /apps)並新增屬性,如下列熒幕擷圖所示:
This example uses "coralui3" library to show a dialog as it is used in the Javascript sample we presented.
You may use different library of your choice.
-
在此使用者端程式庫資料夾底下建立兩個檔案,如下所述:
- 覆寫.js:會有javascript程式碼來處理「insertJIRARef」的點選事件(使用附加的套件取得此javascript的內容)
- js.txt:其中包含「overrides.js」以啟用此javascript
-
儲存變更,您就可以開始測試了。
測試
- 開啟Web編輯器
- 從使用者偏好設定中選擇您新增自訂的資料夾設定檔 ui_config.json. 如果您將其新增至全域設定檔,表示您可能已經在使用它。
- 開啟主題,您會注意到工具列有一個新按鈕「插入Jira參照」
- 然後,您可以將prolog區段新增至主題,並嘗試在prolog元素「change-request-reference」內按一下「插入Jira參考」按鈕
<prolog>
<change-historylist>
<change-item>
<change-request-reference>
</change-request-reference>
<change-completed></change-completed>
<change-summary></change-summary>
</change-item>
</change-historylist>
</prolog>
請參考下方的熒幕擷圖瞭解其外觀:
附件
- 範例clientlibs封裝將安裝具有JavaScript程式碼的Webeditor使用者端程式庫,用於工具列按鈕動作: 使用此連結下載
- 範例 ui_config.json 您可以上傳至資料夾設定檔的: 下載範例ui_config.json
Please note this is compatible to AEM 6.5 and AEM Guides version 4.2.
If you are using a different version please add the toolbar button to the ui_config.json manually.