開發AEM元件

AEM元件可用來保留、格式化及轉譯可在您的網頁上使用的內容。

• 當編寫頁面時，元件可讓作者編輯和設定內容。

  • 例如，當構建Commerce站點時，元件可以從目錄收集和呈現資訊。

    如需詳細資訊，請參閱開發電子商務 。

  • 建立Communities網站時，元件可提供資訊給訪客，並從訪客收集資訊。

    如需詳細資訊，請參閱開發社群。

• 在發佈例項中，元件會呈現您的內容，並依您的網站訪客需求呈現。

程式碼範例

本頁提供開發AEM新元件所需的參考檔案（或參考檔案的連結）。 如需一些實用範例，請參閱開發AEM元件 — 程式碼範例。

結構

元件的基本結構在AEM元件 — 基本知識頁面中介紹。 該檔案涵蓋觸控式和傳統UI。 即使您不需要在新元件中使用傳統設定，在繼承現有元件時仍可注意這些設定。

擴展現有元件和對話框

視您要實作的元件而定，可能會擴充或自訂現有例項，而非從頭定義和開發整個structure。

在擴展或定制現有元件或對話框時，可以在進行更改之前複製或複製對話框所需的整個結構或結構。

擴充現有元件

可以使用資源類型層次結構和相關繼承機制來擴展現有元件。

自訂現有元件對話方塊

您也可以使用Sling Resource Merger並定義屬性sling:resourceSuperType覆寫​元件對話方塊。

這表示您只需重定義所需的差異，而不需重定義整個對話框（使用sling:resourceSuperType）。 現在建議使用此方法來擴充元件對話方塊

如需詳細資訊，請參閱Sling Resource Merger 。

定義標注

元件將以HTML呈現。 元件需要定義HTML，以取得所需內容，然後在製作和發佈環境中視需要呈現。

使用HTML範本語言

隨AEM 6.0推出的HTML範本語言(HTL)取代JSP(JavaServer Pages)，成為HTML偏好且建議的伺服器端範本系統。 對於需要建立強大企業網站的網頁開發人員，HTL有助於提升安全性和開發效率。

開發內容邏輯

此可選邏輯選擇和/或計算要呈現的內容。 系統會從具有適當Use-API模式的HTL運算式中叫用它。

將邏輯與外觀分開的機制有助於釐清對指定檢視的呼叫。 它也允許對相同資源的不同檢視提供不同的邏輯。

使用Java

HTL Java Use-API可讓HTL檔案存取自訂Java類別中的Helper方法。這可讓您使用Java程式碼來實作邏輯，以選取和設定元件內容。

使用JavaScript

HTL JavaScript Use-API可讓HTL檔案存取以JavaScript撰寫的協助程式碼。這可讓您使用JavaScript程式碼來實作邏輯，以選取和設定元件內容。

使用用戶端HTML程式庫

現代網站嚴重依賴由複雜JavaScript和CSS程式碼驅動的用戶端處理。 組織並最佳化此程式碼的服務可能是個複雜的問題。

為了解決此問題，AEM提供​用戶端程式庫資料夾，可讓您將用戶端程式碼儲存在存放庫中，將其組織為類別，並定義將每類程式碼提供給用戶端的時間和方式。 然後，用戶端程式庫系統會負責在您的最終網頁中產生正確的連結，以載入正確的程式碼。

如需詳細資訊，請參閱使用用戶端HTML程式庫 。

設定編輯行為

您可以配置元件的編輯行為，包括可用於元件的操作、就地編輯器的特性以及與元件上的事件相關的監聽器等屬性。 觸控式和傳統UI都會使用此設定，雖然有某些特定差異。

通過在元件節點（cq:Component類型）下添加cq:EditConfig類型的cq:editConfig節點，以及通過添加特定屬性和子節點來配置元件的編輯行為。

設定預覽行為

切換至​預覽​模式時，即使未重新整理頁面，也會設定WCM模式 Cookie。

對於呈現時對WCM模式敏感的元件，必須定義元件以明確重新整理元件，然後仰賴Cookie的值。

建立和設定對話方塊

對話方塊可讓作者與元件互動。 使用對話方塊可讓作者和/或管理員編輯內容、設定元件或定義設計參數（使用設計對話方塊）

Coral UI和Granite UI

Coral UI 和 Granite UI定義AEM的現代外觀。

Granite UI提供在製作環境中建立對話方塊所需的大量基本元件(Widget) 。如有必要，您可以擴充此選取範圍並建立您自己的介面工具集。

如需完整詳細資訊，請參閱：

• Coral UI

  • 在所有雲端解決方案中提供一致的UI
  • AEM觸控式UI的概念 — Coral UI
  • Coral UI 指南

• Granite UI

  • 提供包裝在Sling元件中的Coral UI標籤，以建立UI主控台和對話方塊
  • AEM觸控式UI的概念 — Granite UI
  • Granite UI檔案

建立新對話方塊

觸控式UI的對話方塊：

• 名為cq:dialog。

• 定義為具有sling:resourceType屬性集的nt:unstructured節點。

• 位於其cq:Component節點下，且位於其元件定義旁。

• 會根據其內容結構和sling:resourceType屬性，在伺服器端轉譯（作為Sling元件）。

• 使用Granite UI架構。

• 包含描述對話框中欄位的節點結構。

  • 這些節點為nt:unstructured，具有所需的sling:resourceType屬性。

範例節點結構可能是：

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

自訂對話方塊類似於開發元件，因為對話方塊本身是元件（亦即元件指令碼呈現的標籤與用戶端程式庫提供的行為/樣式）。

如需範例，請參閱：

• /libs/foundation/components/text/cq:dialog
• /libs/foundation/components/download/cq:dialog

自訂對話方塊欄位

建立新欄位

觸控式UI的Widget會實作為Granite UI元件。

若要建立新介面工具集以用於觸控式UI的元件對話方塊中，您必須建立新的Granite UI欄位元件。

如果您將對話方塊視為表單元素的簡單容器，則您也可以將對話方塊內容的主要內容視為表單欄位。 建立新表單欄位需要建立資源類型；這等同於建立新元件。 為協助您完成該工作，Granite UI提供要繼承的通用欄位元件（使用sling:resourceSuperType）:

/libs/granite/ui/components/coral/foundation/form/field

更具體來說，Granite UI提供一系列欄位元件，這些元件適合用於對話方塊（或更一般地說，位於forms中）。

建立資源類型後，可以在對話方塊中新增新節點，並使用引用您剛引入的資源類型的屬性sling:resourceType來實例化欄位。

建立樣式和行為的用戶端程式庫

如果您想要定義元件的樣式和行為，可以建立專用的用戶端程式庫來定義自訂CSS/LESS和JS。

若要讓用戶端程式庫僅為元件對話方塊載入（即不會為其他元件載入），您必須將對話方塊的屬性extraClientlibs設為您剛建立之用戶端程式庫的類別名稱。 如果您的用戶端程式庫相當大，且/或您的欄位是該對話方塊專屬的，且在其他對話方塊中不需要，則建議您這麼做。

若要讓所有對話方塊都載入您的用戶端程式庫，請將用戶端程式庫的類別屬性設為cq.authoring.dialog。 這是呈現所有對話框時預設包含的客戶端庫的類別名稱。 如果客戶端庫很小，且/或欄位是通用欄位，並且可在其他對話框中重複使用，則要執行此操作。

如需範例，請參閱：

• cqgems/customizingfield/components/colorpicker/clientlibs

  • 由程式碼範例提供

延伸（繼承）欄位

視您的需求而定，您可以：

• 依元件繼承(sling:resourceSuperType)擴充指定的Granite UI欄位
• 遵循介面工具集API（JS/CSS繼承），從基礎介面工具集程式庫擴充指定介面工具集（若是Granite UI，即為Coral UI）

對對話框欄位的訪問

您也可以使用呈現條件(rendercondition)來控制誰有權存取對話方塊中的特定索引標籤/欄位；例如：

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

處理欄位事件

處理對話欄位上事件的方法現在已透過自訂用戶端程式庫🔗中的接聽程式完成。 這與內容結構中監聽器的舊方法有所不同。

自定義客戶端庫中的偵聽器

若要將邏輯插入欄位，您應：

1. 將欄位標示為指定的CSS類別(hook)。
2. 在您的用戶端資料庫中，定義與該CSS類別名稱掛鈎的JS接聽程式（這可確保您的自訂邏輯只限於欄位，不會影響相同類型的其他欄位）。

若要達成此目標，您必須了解您要與之互動的基礎Widget程式庫。 請參閱Coral UI檔案 ，識別您要對哪個事件做出反應。 這與您過去必須使用ExtJS執行的程式非常類似：尋找指定介面工具集的檔案頁面，然後查看其事件API的詳細資訊。

如需範例，請參閱：

• cqgems/customizingfield/components/clientlibs/customizingfield

  • 由程式碼範例提供

內容結構中的監聽器

在具有ExtJS的傳統UI中，通常會在內容結構中擁有指定Widget的聽眾。 在觸控式UI中達到相同的效果，與內容中不再定義JS接聽程式程式碼（或任何程式碼）不同。

內容結構描述了語義結構；它不應（必須）暗示基礎小工具的性質。 內容結構中沒有JS程式碼，即可變更實作詳細資料，而無須變更內容結構。 換言之，您無需接觸內容結構即可變更介面工具集資料庫。

檢測對話框的可用性

如果您有自訂JavaScript，只需在對話方塊可用且準備就緒時執行，則應監聽dialog-ready事件。

每當對話方塊載入（或重新載入）且可供使用時，就會觸發此事件，這表示每當對話方塊的DOM中有變更（建立/更新）時。

dialog-ready 可用來在JavaScript自訂程式碼中連結，該程式碼會對對話方塊或類似工作中的欄位執行自訂。

欄位驗證

必填欄位

若要將指定欄位標示為必要欄位，請在欄位的內容節點上設定下列屬性：

• 名稱: required
• 類型: Boolean

如需範例，請參閱：

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

欄位驗證(Granite UI)

Granite UI和Granite UI元件（等同於Widget）中的欄位驗證是使用foundation-validation API完成。 如需詳細 foundation-valdiation 資訊，請參閱Granite檔案。

如需範例，請參閱：

• cqgems/customizingfield/components/clientlibs/customizingfield/js/validations.js

  • 由程式碼範例提供

• /libs/cq/gui/components/authoring/dialog/clientlibs/dialog/js/validations.js

建立和設定設計對話方塊

當元件具有可在設計模式中編輯的設計詳細資訊時，將提供「設計」對話框。

定義與用於編輯內容🔗的對話框的定義非常相似，其不同之處在於它定義為節點：

• 節點名稱：cq:design_dialog
• 類型: nt:unstructured

建立和設定就地編輯器

就地編輯器允許用戶直接編輯段落流中的內容，而無需開啟對話框。 例如，標準的「文字」和「標題」元件都有內置編輯器。

對於每個元件類型，就地編輯器並非必要/有意義的。

如需詳細資訊，請參閱延伸頁面編寫 — 新增就地編輯器 。

自訂元件工具列

元件工具欄為用戶提供對元件的一系列操作（如編輯、配置、複製和刪除）的訪問。

如需詳細資訊，請參閱延伸頁面編寫 — 將新動作新增至元件工具列 。

為參考邊欄配置元件（借/借）

如果您的新元件參考來自其他頁面的內容，則您可以考慮是否要影響​參考​邊欄的​借入內容​和​借出內容​區段。

現成可用的AEM只會檢查「參考」元件。 若要新增元件，您需要設定OSGi套件組合​WCM編寫內容參考設定。

在定義中建立新條目，指定元件以及要檢查的屬性。 例如：

/apps/<your-Project>/components/reference@parentPath

啟用元件並將其添加到段落系統

開發元件後，必須啟用該元件以在適當的段落系統中使用，以便在所需的頁面上使用。

這可透過下列任一方式完成：

• 編輯特定頁面時使用設計模式。
• 在模板的段落系統上定義元件屬性。

配置段落系統以便拖動資產可建立元件實例

AEM提供在頁面上設定段落系統的可能性，以便當使用者拖曳（適當）資產至該頁面的例項時，系統會自動建立新元件的例項（而不必一律拖曳空白元件至頁面）。

此行為和所需的資產對元件關係可以設定：

1. 在頁面設計的段落定義下。 例如：

   • /etc/designs/<myApp>/page/par

   建立新節點：

   • 名稱: cq:authoring
   • 類型: nt:unstructured

2. 在此下，建立新節點以保留所有資產對元件的對應：

   • 名稱: assetToComponentMapping
   • 類型: nt:unstructured

3. 對於每個資產對元件對應，請建立節點：

   • 名稱：文字；建議名稱指明資產及相關元件類型；例如，影像
   • 類型: nt:unstructured

   每個都具有下列屬性：

   • assetGroup:

     • 類型: String
     • 值：資產所屬之本集團；例如， media

   • assetMimetype:

     • 類型: String
     • 值：相關資產的mime類型；例如image/*

   • droptarget:

     • 類型: String
     • 值：投放目標；例如， image

   • resourceType:

     • 類型: String
     • 值：相關元件資源；例如， foundation/components/image

   • type:

     • 類型: String
     • 值：類型，例如Images

如需範例，請參閱：

• /etc/designs/geometrixx/jcr:content/page/par/cq:authoring
• /etc/designs/geometrixx-outdoors/jcr:content/page/par/cq:authoring
• /etc/designs/geometrixx-media/jcr:content/article/article-content-par/cq:authoring

GITHUB上的程式碼

您可以在GitHub上找到此頁面的程式碼

• 在GitHub上開啟aem-project-archetype專案
• 將專案下載為a ZIP檔案

使用AEM Brackets擴充功能

AEM Brackets擴充功能提供編輯AEM元件和用戶端程式庫的順暢工作流程。 它以Brackets程式碼編輯器為基礎。

擴充功能：

• 簡化同步（無需Maven或File Vault），以幫助提高開發人員的效率，並幫助具有有限AEM知識的前端開發人員參與項目。
• 提供某些HTL支援，此範本語言旨在簡化元件開發並提高安全性。

從傳統元件移轉

將專為搭配傳統UI使用而設計的元件移轉至可搭配觸控式UI使用的元件（單獨或共同使用）時，應考量下列問題：

• HTL

  • 不強制使用HTL，但如果您的元件需要更新，則是考慮從JSP移轉至HTL🔗的理想時機。

• 元件

  • 移轉使用傳統UI特定函式的 cq:listener程式碼
  • RTE外掛程式，如需詳細資訊，請參閱設定RTF編輯器。
  • 移 cq:listener 轉使用傳統UI專用函式的程式碼

• 對話方塊

  • 您必須建立新對話方塊，才能在觸控式UI中使用。 不過，為了相容性目的，當未為觸控式UI定義對話方塊時，觸控式UI可使用傳統UI對話方塊的定義。
  • AEM現代化工具可協助您擴充現有元件。
  • 將ExtJS對應至Granite UI元 件可方便地概略說明ExtJS xtypes和節點類型，以及其相等的Granite UI資源類型。
  • 自訂欄位，如需詳細資訊，請參閱自訂對話方塊欄位上的AEM Gems工作階段。
  • 從vtypes移轉至Granite UI驗證
  • 使用JS監聽器，如需詳細資訊，請參閱處理欄位事件和自訂對話欄位上的AEM Gems工作階段。

移轉cq:listener程式碼

如果您要移轉專為傳統UI設計的專案，cq:listener程式碼（以及與元件相關的clientlib）可能會使用傳統UI專屬的函式（例如CQ.wcm.*）。 在移轉作業中，您必須使用觸控式UI中的對等物件/函式來更新此類程式碼。

如果您的專案正完全移轉至觸控式UI，則您需要取代此類程式碼，以使用與觸控式UI相關的物件和函式。

不過，如果您的專案在移轉期間（通常的情況）必須同時適用傳統UI和觸控式UI，則您需要實作切換器，以區分參考適當物件的個別程式碼。

此切換機制可實作為：

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

記錄元件

身為開發人員，您需要輕鬆存取元件檔案，以便快速了解：

• 說明
• 預期用途
• 內容結構和屬性
• 公開的API和擴充功能點
• 等

因此，很容易就能在元件本身內使用任何現有的檔案標籤。

您只需將README.md檔案置於元件結構中即可。 此Markdown會顯示在元件主控台中。

支援的Markdown與內容片段的標籤相同。