元件參考指南

元件是在AEM中建立體驗的核心。 此 核心元件 和 AEM專案原型 使用一組現成且強大的元件，輕鬆開始使用。 此 WKND教學課程 帶開發人員瞭解如何使用這些工具，以及如何建立自訂元件，以建立新的AEM網站。

由於WKND教學課程涵蓋大部分的使用案例，因此本檔案僅作為這些資源的補充。 它提供在AEM中如何建構和設定元件的深入技術細節，並非旨在作為快速入門手冊。

概觀

本節說明開發您自己的元件時所需詳細資訊的主要概念和問題。

規劃

開始實際設定元件或為元件編寫程式碼之前，您應該先詢問：

• 您到底需要新元件做什麼？
• 您是否需要從頭開始建立元件，或是繼承現有元件的基本知識？
• 您的元件需要邏輯來選取/操作內容嗎？
  • 邏輯應與使用者介面層分開。 HTL的設計目的是協助確保做到這一點。
• 您的元件是否需要CSS格式？
  • CSS格式應與元件定義分開。 定義命名您的HTML元素的慣例，以便您可以透過外部CSS檔案來修改它們。
• 您的新元件可能會帶來哪些安全性影響？

重複使用現有元件

在投入時間建立全新元件之前，請考慮自訂或擴充現有元件。 核心元件 提供一套彈性、強大且經過充分測試的生產就緒元件。

擴充核心元件

核心元件也提供 清除自訂模式 以根據您自己的專案需求加以調整。

覆蓋元件

也可以使用重新定義元件 覆蓋 根據搜尋路徑邏輯。 但在這種情況下， Sling資源合併 將不會觸發，並且 /apps 必須定義整個覆蓋。

延伸元件對話方塊

也可以使用Sling資源合併器並定義屬性來覆寫元件對話方塊 sling:resourceSuperType.

這表示您只需要重新定義所需的差異，而不必重新定義整個對話方塊。

內容邏輯和演算標籤

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

建議將負責標籤和轉譯的程式碼，與控制用來選取元件內容的邏輯的程式碼分開。

支援此理念的有 HTL，一種範本化語言，特意限制以確保使用真正的程式設計語言來定義基礎商業邏輯。 此機制會反白標示為指定檢視呼叫的程式碼，並視需要為相同元件的不同檢視允許特定邏輯。

此（選用）邏輯可透過不同方式實作，並使用特定命令從HTL叫用：

• 使用Java - HTL Java Use-API 讓HTL檔案能夠存取自訂Java類別中的helper方法。 這可讓您使用Java程式碼來實作邏輯，以選取和設定元件內容。
• 使用JavaScript - HTL JavaScript Use-API 讓HTL檔案能夠存取以JavaScript撰寫的helper程式碼。 這可讓您使用JavaScript程式碼來實作選取和設定元件內容的邏輯。
• 使用使用者端資料庫 — 現代網站重度依賴由複雜JavaScript和CSS程式碼驅動的使用者端處理。 檢視檔案 在AEMas a Cloud Service上使用使用者端資料庫 以取得詳細資訊。

元件結構

AEM元件的結構既強大又靈活。 主要部分為：

• 資源類型
• 元件定義
• 元件的屬性和子節點
• 對話方塊
• 設計對話方塊

資源類型

結構的一個關鍵元素是資源型別。

• 內容結構會宣告意圖。
• 資源型別會實作它們。

這是一個抽象，有助於確保即使當外觀和感覺隨著時間改變時，意圖仍會維持在時間上。

元件定義

元件的定義可劃分如下：

• AEM元件是根據 Sling。
• AEM元件位於 /libs/core/wcm/components.
• 專案/網站特定元件位於 /apps/<myApp>/components.
• AEM標準元件的定義為 cq:Component 並具備關鍵元素：
  • jcr屬性 — jcr屬性的清單。 這些是變數，有些可能是選用的，但元件節點的基本結構、其屬性和子節點由定義 cq:Component 定義。
  • 資源 — 這些會定義元件使用的靜態元素。
  • 指令碼 — 這些用於實作元件之結果執行個體的行為。

重要屬性

• 根節點：
  • <mycomponent> (cq:Component) — 元件的階層節點。
• 重要屬性：
  • jcr:title — 元件標題；例如，當元件列於 元件瀏覽器 和 元件主控台
  • jcr:description — 元件的說明；在元件瀏覽器和元件主控台中作為滑鼠懸停提示使用
  • 請參閱區段 元件圖示 以取得詳細資訊
• 重要子節點：
  • cq:editConfig (cq:EditConfig) — 定義元件的編輯屬性，並讓元件出現在元件瀏覽器中
    • 如果元件有對話方塊，即使cq：editConfig不存在，它也會自動出現在「元件」瀏覽器或Sidekick中。
  • cq:childEditConfig (cq:EditConfig) — 控制未定義其本身的子元件的作者UI方面 cq:editConfig.
  • cq:dialog (nt:unstructured) — 此元件的對話方塊。 定義允許使用者設定元件和/或編輯內容的介面。
  • cq:design_dialog (nt:unstructured) — 此元件的設計編輯

元件圖示

當開發人員建立元件時，元件的圖示或縮寫會透過元件的JCR屬性來定義。 系統會依下列順序評估這些屬性，並使用找到的第一個有效屬性。

1. cq:icon — 字串屬性，指向中的標準圖示 Coral UI程式庫 以在元件瀏覽器中顯示
   • 使用Coral圖示的HTML屬性值。
2. abbreviation — 字串屬性，用於自訂元件瀏覽器中元件名稱的縮寫
   • 縮寫應限製為兩個字元。
   • 提供空字串將會建置的前兩個字元中的縮寫 jcr:title 屬性。
     • 例如，"Im"代表"Image"
     • 當地語系化標題將用於建置縮寫。
   • 只有元件具備以下條件時，才會轉譯縮寫： abbreviation_commentI18n 屬性，然後用作翻譯提示。
3. cq:icon.png 或 cq:icon.svg — 此元件的圖示，會顯示在元件瀏覽器中
   • 20 x 20畫素是標準元件的圖示大小。
     • 較大的圖示將會縮小（使用者端）。
   • 建議的色彩為rgb(112， 112， 112) > #707070
   • 標準元件圖示的背景是透明的。
   • 僅限 .png 和 .svg 檔案受到支援。
   • 如果透過Eclipse外掛程式從檔案系統匯入，檔案名稱需要逸出為 _cq_icon.png 或 _cq_icon.svg 例如。
   • .png 先決條件優先 .svg 如果兩者都存在。

如果以上屬性均非(cq:icon， abbreviation， cq:icon.png 或 cq:icon.svg)可在此元件中找到：

• 系統會在超級元件上搜尋以下專案後的相同屬性 sling:resourceSuperType 屬性。
• 如果在超級元件層級中找不到任何專案或空白縮寫，系統會從 jcr:title 目前元件的屬性。

若要取消從超級元件繼承圖示，請將設定為空白 abbreviation 元件上的屬性將恢復為預設行為。

此 元件主控台 顯示如何定義特定元件的圖示。

SVG圖示範例

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px"
     width="20px" height="20px" viewBox="0 0 20 20" enable-background="new 0 0 20 20" xml:space="preserve">
    <ellipse cx="5" cy="5" rx="3" ry="3" fill="#707070"/>
    <ellipse cx="15" cy="5" rx="4" ry="4" fill="#707070"/>
    <ellipse cx="5" cy="15" rx="5" ry="5" fill="#707070"/>
    <ellipse cx="15" cy="15" rx="4" ry="4" fill="#707070"/>
</svg>

元件的屬性和子節點

定義元件所需的許多節點/屬性對這兩個UI都是通用的，不同之處保持獨立，以便您的元件可在兩個環境中運作。

元件是型別的節點 cq:Component 和擁有下列屬性和子節點：

如果檢視 文字 元件中，我們可以看到許多元素：

特別感興趣的屬性包括：

• jcr:title — 這是元件的標題，用於識別元件瀏覽器中的元件。
• jcr:description — 這是元件的說明。
• sling:resourceSuperType — 這表示擴充元件時的繼承路徑（透過覆寫定義）。

特別感興趣的子節點包括：

• cq:editConfig — 這控制了編輯時元件的視覺方面。
• cq:dialog — 這會定義用於編輯此元件內容的對話方塊。
• cq:design_dialog — 這會指定此元件的設計編輯選項。

對話方塊

對話方塊是元件的關鍵元素，因為它們為作者提供介面，以便在內容頁面上設定元件並提供該元件的輸入。 請參閱 製作檔案 以取得內容作者如何與元件互動的詳細資訊。

根據元件的複雜性，您的對話方塊可能需要一個或多個標籤。

AEM元件的對話方塊：

• 為 cq:dialog 型別的節點 nt:unstructured.
• 位於其 cq:Component 節點及其元件定義旁邊。
• 定義用於編輯此元件內容的對話方塊。
• 使用Granite UI元件定義。
• 根據它們的內容結構和 sling:resourceType 屬性。
• 包含描述對話方塊內欄位的節點結構
  • 這些節點為 nt:unstructured 具有必要的 sling:resourceType 屬性。

在對話方塊中，會定義個別欄位：

設計對話方塊

「設計」對話方塊類似於用來編輯和設定內容的對話方塊，但它們為範本作者提供了介面，以便預先設定並提供頁面範本上該元件的設計詳細資訊。 然後，內容作者會使用頁面範本來建立內容頁面。 請參閱 範本檔案 有關如何建立範本的詳細資訊。

編輯頁面範本時會使用設計對話方塊，但並非所有元件都需要。 例如 標題 和 影像元件 兩者都有設計對話方塊，而 社群媒體分享元件 不會。

Coral UI和Granite UI

Coral UI和Granite UI定義了AEM的外觀和風格。

• Coral UI 在所有雲端解決方案中提供一致的UI。
• Granite UI 提供包在Sling元件中的Coral UI標籤，用於建置UI主控台和對話方塊。

Granite UI提供在製作環境中建立對話方塊所需的大量基本Widget。 必要時，您可以擴充此選取範圍並建立自己的Widget。

如需其他詳細資訊，請參閱下列資源：

• AEM UI 的結構

自訂對話方塊欄位

若要建立新的Widget以用於元件對話方塊，需要您建立新的Granite UI欄位元件。

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

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

更具體地說，Granite UI提供了一系列適合在對話方塊中使用的欄位元件，或更一般地說， 表單。

建立資源型別後，您可以在對話方塊中新增節點（包含屬性），將欄位具現化 sling:resourceType 請參閱您剛才介紹的資源型別。

對話方塊欄位的存取權

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

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

使用元件

建立元件後，您需要啟用它才能使用它。 使用它會顯示元件的結構與存放庫中結果內容的結構有何關係。

將元件新增至範本

定義元件後，必須使其可供使用。 若要讓元件可在範本中使用，您必須在範本配置容器的原則中啟用元件。

請參閱 範本檔案 有關如何建立範本的詳細資訊。

元件及其建立的內容

如果我們建立並設定的執行個體 標題 頁面上的元件： /content/wknd/language-masters/en/adventures/extreme-ironing.html

然後我們就能檢視在存放庫中建立的內容結構：

特別是，如果您檢視 標題元件：

• 內容包含 jcr:title 保留作者輸入之標題的實際文字的屬性。
• 其中也包含 sling:resourceType 元件定義的參照。

定義的屬性取決於個別定義。 雖然這些規則可能比上述規則更複雜，但還是會遵循相同的基本原則。

元件階層與繼承

AEM中的元件須遵守 資源型別階層. 這可用來使用屬性擴充元件 sling:resourceSuperType. 這可讓元件繼承自其他元件。

請參閱區段 重複使用元件 以取得詳細資訊。

編輯行為

本節說明如何設定元件的編輯行為。 這包括元件可用的動作、in.place編輯器的特性，以及與元件上事件相關的接聽程式等屬性。

元件的編輯行為可透過新增以下專案來設定： cq:editConfig 型別的節點 cq:EditConfig 元件節點下方(型別 cq:Component)，並新增特定屬性和子節點。 下列屬性和子節點可供使用：

• cq:editConfig 節點屬性
• cq:editConfig 子節點：
  • cq:dropTargets (節點型別 nt:unstructured)：定義可以從內容尋找器的資產接受放置的放置目標清單（允許單一放置目標）
  • cq:inplaceEditing (節點型別 cq:InplaceEditingConfig)：定義元件的就地編輯設定
  • cq:listeners (節點型別 cq:EditListenersConfig)：定義在元件上發生動作之前或之後所發生的事情

AEM中有許多現有設定。 您可以使用中的查詢工具輕鬆搜尋特定屬性或子節點 CRXDE Lite.

元件預留位置

元件必須一律呈現作者可見的一些HTML，即使元件沒有內容亦然。 否則，它可能會從編輯器的介面中消失，在技術上呈現，但在頁面和編輯器中不可見。 在這種情況下，作者將無法選取空白元件並與之互動。

因此，元件應該呈現預留位置，前提是在頁面編輯器中呈現頁面時(當WCM模式為 edit 或 preview)。
預留位置的典型HTML標籤如下：

<div class="cq-placeholder" data-emptytext="Component Name"></div>

轉譯上述預留位置HTML的典型HTL指令碼如下：

<div class="cq-placeholder" data-emptytext="${component.properties.jcr:title}"
     data-sly-test="${(wcmmode.edit || wcmmode.preview) && isEmpty}"></div>

在上一個範例中， isEmpty 是一個變數，只有在元件沒有內容且作者看不到時才會成立。

為避免重複，Adobe建議元件的實作者對這些預留位置使用HTL範本， 如核心元件所提供的那種。

接著，使用先前連結中的範本並使用下列HTL行完成：

<sly data-sly-use.template="core/wcm/components/commons/v1/templates.html"
     data-sly-call="${template.placeholder @ isEmpty=!model.text}"></sly>

在上一個範例中， model.text 是變數，只有在內容具有內容且可見時才會成立。

此範本的範例使用方式可在核心元件中檢視， 例如，在標題元件中。

使用cq：EditConfig子節點進行設定

將資產拖放至對話方塊 — cq：dropTargets

此 cq:dropTargets 節點（節點型別） nt:unstructured)定義可以接受從內容尋找器拖曳之資產中放置的放置目標。 它是型別節點 cq:DropTargetConfig.

型別的子節點 cq:DropTargetConfig 會在元件中定義放置目標。

就地編輯 — cq：inplaceEditing

就地編輯器可讓使用者直接在內容流程中編輯內容，而不需要開啟對話方塊。 例如，標準 文字 和 標題 元件都有就地編輯器。

並非每個元件型別都需要/有意義的就地編輯器。

此 cq:inplaceEditing 節點（節點型別） cq:InplaceEditingConfig)會為元件定義就地編輯設定。 它可以有以下屬性：

以下設定可讓您就地編輯元件並定義 plaintext 作為編輯器型別：

    <cq:inplaceEditing
        jcr:primaryType="cq:InplaceEditingConfig"
        active="{Boolean}true"
        editorType="plaintext"/>

處理欄位事件 — cq：listeners

處理對話方塊欄位上的事件的方法，是使用自訂中的接聽程式來完成 使用者端資源庫。

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

• 讓您的欄位標籤指定CSS類別（鉤點）。
• 在您的使用者端資料庫中定義連結至該CSS類別名稱的JS接聽程式（這可確保您的自訂邏輯範圍僅限定在您的欄位中，不會影響相同型別的其他欄位）。

若要達成此目的，您必須瞭解您要與其互動的基礎Widget程式庫。 請參閱Coral UI檔案 以識別您要對哪個事件做出反應。

此 cq:listeners 節點（節點型別） cq:EditListenersConfig)會定義在元件上執行動作之前或之後所發生的事情。 下表定義其可能的屬性。

事件處理常式可使用自訂實施來實施。 例如(其中 project.customerAction 是靜態方法)：

afteredit = "project.customerAction"

以下範例等同於 REFRESH_INSERTED 設定：

afterinsert="function(path, definition) { this.refreshCreated(path, definition); }"

使用下列設定時，頁面會在刪除、編輯、插入或移動元件後重新整理：

    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="REFRESH_PAGE"
        afteredit="REFRESH_PAGE"
        afterinsert="REFRESH_PAGE"
        afterMove="REFRESH_PAGE"/>

欄位驗證

Granite UI和Granite UI Widget中的欄位驗證已透過使用 foundation-validation API。 請參閱 foundation-valdiation Granite檔案 以取得詳細資訊。

偵測對話方塊的可用性

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

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

dialog-ready 可用於掛接JavaScript自訂程式碼，以在對話方塊或類似工作的欄位上執行自訂。

預覽行為

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

對於呈現時對WCM模式敏感的元件，需要將其定義為專門重新整理自身，然後依賴Cookie的值。

記錄元件

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

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

因此，很容易讓元件本身隨附任何現有的檔案Markdown 。

您只需放置 README.md 檔案。

然後，此Markdown會顯示在 元件主控台。

支援的Markdown與 內容片段.

Business.Adobe.com 資源