瞭解如何編寫樣式系統的程式碼

在本影片中，我們將瞭解CSS的剖析(或 LESS)和JavaScript，用來使用樣式系統設定Experience Manager核心標題元件的樣式，以及這些樣式套用至HTML和DOM的方式。

瞭解如何編寫樣式系統的程式碼

提供的AEM套件(technical-review.sites.style-system-1.0.0.zip)安裝範例標題樣式、We.Retail配置容器和標題元件的範例原則，以及範例頁面。

technical-review.sites.style-system-1.0.0.zip

CSS

以下為 LESS 在以下位置找到的範例樣式的定義：

• /apps/demo/sites/style-system/clientlib-example/components/titles/styles/example.less

對於偏好使用CSS的客戶，此程式碼片段下方是CSS LESS 編譯至。

/* LESS */
.cmp-title--example {
 .cmp-title {
  text-align: center;

  .cmp-title__text {
   color: #EB212E;
   font-weight: 600;
   font-size: 5rem;
   border-bottom: solid 1px #ddd;
   padding-bottom: 0;
   margin-bottom: .25rem
  }

  // Last Modified At element injected via JS
  .cmp-title__last-modified-at {
   color: #999;
   font-size: 1.5rem;
   font-style: italic;
   font-weight: 200;
  }
 }
}

以上 LESS 會透過Experience Manager至下列CSS以原生方式編譯。

/* CSS */
.cmp-title--example .cmp-title {
 text-align: center;
}

.cmp-title--example .cmp-title .cmp-title__text {
 color: #EB212E;
 font-weight: 600;
 font-size: 5rem;
 border-bottom: solid 1px #ddd;
 padding-bottom: 0;
 margin-bottom: 0.25rem;
}

.cmp-title--example .cmp-title .cmp-title__last-modified-at {
 color: #999;
 font-size: 1.5rem;
 font-style: italic;
 font-weight: 200;
}

JavaScript

將範例樣式套用至標題元件時，下列JavaScript會收集並插入目前頁面在標題文字下方的上次修改日期和時間。

jQuery的使用是選用的，也可以選擇使用的命名慣例。

以下為 LESS 在以下位置找到的範例樣式的定義：

• /apps/demo/sites/style-system/clientlib-example/components/titles/styles/js/title.js

/**
 * JavaScript supporting Styles may be re-used across multi Component Styles.
 *
 * For example:
 * Many styles may require the Components Image (provided via an <img> element) to be set as the background-image.
 * A single JavaScript function may be used to adjust the DOM for all styles that required this effect.
 *
 * JavaScript must react to the DOMNodeInserted event to handle style-switching in the Page Editor Authoring experience.
 * JavaScript must also run on DOM ready to handle the initial page load rendering (AEM Publish).
 * JavaScript must mark and check for elements as processed to avoid cyclic processing (ie. if the JavaScript inserts a DOM node of its own).
 */
jQuery(function ($) {
    "use strict;"

    moment.locale("en");

    /**
     * Method that injects p element, containing the current pages last modified date/time, under the title text.
     *
     * Similar to the CSS Style application, component HTML elements should be targeted via the BEM class names (as they define the stable API)
     * and targeting "raw" elements (ex. "li", "a") should be avoided.
     */
    function applyComponentStyles() {

        $(".cmp-title--example").not("[data-styles-title-last-modified-processed]").each(function () {
            var title = $(this).attr("data-styles-title-last-modified-processed", true),
                url = Granite.HTTP.getPath() + ".model.json";

            $.getJSON(url, function(data) {
                var dateObject = moment(data['lastModifiedDate']),
                    titleText = title.find('.cmp-title__text');

                titleText.after($("<p>").addClass("cmp-title__last-modified-at").text("Last modified " + dateObject.fromNow()));
            });
        });
    }

    // Handle DOM Ready event
    applyComponentStyles();

    // Apply Styles when a component is inserted into the DOM (ie. during Authoring)
    $(".responsivegrid").bind("DOMNodeInserted", applyComponentStyles);
});

開發最佳實務

HTML最佳實務

• HTML（透過HTL產生）在結構上應儘可能符合語意，避免對元素進行不必要的分組/巢狀。
• HTML元素應可透過BEM樣式CSS類別進行定址。

好 — 元件中的所有元素均可透過BEM標籤法定址：

<!-- Good practice -->
<div class="cmp-list">
    <ul class="cmp-list__item-group">
        <li class="cmp-list__item">...</li>
    </ul>
</div>

不良 — 清單和清單元素僅可依元素名稱定址：

<!-- Bad practice -->
<div class="cmp-list">
    <ul>
        <li>...</li>
    </ul>
</div>

• 公開更多資料並隱藏資料，總比公開太少的資料（需要未來的後端開發）來公開資料要好。

  • 實作可製作的內容切換可協助讓此HTML保持精簡狀態，讓作者能夠選取要將哪些內容元素寫入HTML。 在將影像寫入可能無法用於所有樣式的HTML時，尤其重要。

  • 此規則的例外情況是昂貴資源（例如影像）依預設會公開，因為在此情況下，CSS隱藏的事件影像會不必要地擷取。

    • 現代影像元件通常會使用JavaScript來選取和載入最適合使用案例（檢視區）的影像。

CSS最佳作法

• 使用前置處理器，例如 更少 (由AEM原生支援)或 SCSS （需要自訂建置系統）才能清除CSS定義及重複使用。

• 保持選擇器的權重/特異性一致；這有助於避免和解決難以識別的CSS重疊顯示衝突。

• 將每個樣式組織成獨立檔案。

  • 這些檔案可以使用LESS/SCSS合併 @imports 或者，如果需要原始CSS，可透過HTML使用者端資料庫檔案包含或自訂前端資產建置系統。

• 避免混合許多複雜的樣式。

  • 單一時間可套用至元件的樣式越多，排列的多樣性就越多。 這可能變得難以維護/QA/確保品牌一致性。

• 一律使用CSS類別（遵循BEM標籤法）來定義CSS規則。

  • 如果選取不含CSS類別的元素（即裸元素）是絕對必要的，請在CSS定義中將其移至較高位置，以清楚表明其特定性低於與該型別元素發生的可選CSS類別的所有衝突。

• 避免樣式化 BLOCK--MODIFIER 直接選取，因為這會附加至回應式格線。 變更此元素的顯示可能會影響回應式格線的演算和功能，因此只有在意圖變更回應式格線的行為時才會在此層級顯示樣式。

• 套用樣式範圍，使用 BLOCK--MODIFIER. 此 BLOCK__ELEMENT--MODIFIERS 可以在元件中使用，但由於 BLOCK 代表元件，而元件是設定的樣式，樣式是透過以下方式「定義」和設定範圍 BLOCK--MODIFIER.

CSS選取器結構範例應如下所示：

若是巢狀元件，這些巢狀「元件」元素的CSS選取器深度將超過第3層選取器。 對巢狀元件重複相同的模式，但範圍依父元件的設定 BLOCK. 換句話說，啟動巢狀元件的 BLOCK 位於第3層級，而巢狀元件的 ELEMENT 位於第4個選擇器層級。

JavaScript最佳作法

本節中定義的最佳實務與「style-JavaScript」有關，或JavaScript是專門為了風格而非功能目的而操控元件。

• Style-JavaScript應審慎使用，且為少數使用案例。
• Style-JavaScript應該主要用於操控元件的DOM，以支援CSS的樣式設定。
• 如果元件會在頁面上出現多次，請重新評估Javascript的使用，並瞭解計算/和重新繪製成本。
• 如果元件在頁面上可能出現多次時，Javascript以非同步(透過AJAX)方式提取新資料/內容，請重新評估其使用。
• 處理發佈和編寫體驗。
• 儘可能重複使用style-Javascript。
  • 例如，如果元件的多個樣式需要將影像移至背景影像，style-JavaScript可以實作一次，並附加至多個樣式 BLOCK--MODIFIERs.
• 儘可能將style-JavaScript與功能性JavaScript分開。
• 評估JavaScript的成本與直接透過HTL在HTML中顯示這些DOM變更的成本。
  • 當使用style-JavaScript的元件需要伺服器端修改時，請評估此時是否可以引入JavaScript操作，以及這對元件的效能和可支援性有何影響/影響。

效能考量事項

• Style-JavaScript應保持精簡和纖細。
• 為避免閃爍和不必要的重新繪製，一開始透過隱藏元件 BLOCK--MODIFIER BLOCK，並在JavaScript中的所有DOM操作完成時顯示。
• style-JavaScript操作的效能類似於DOMReady上附加及修改元素的基本jQuery外掛程式。
• 確保請求已壓縮，且CSS和JavaScript已縮制。

其他資源

• 樣式系統檔案
• 建立AEM使用者端資料庫
• BEM （區塊元素修飾元）檔案網站
• LESS檔案網站
• jQuery網站