瞭解樣式系統最佳實務 understanding-style-organization-with-the-aem-style-system

NOTE
請在以下網址檢閱內容: 瞭解如何編寫樣式系統的程式碼,以確保瞭解AEM樣式系統所使用的類似BEM的慣例。

針對「AEM樣式系統」實作有兩種主要風格或樣式:

  • 配置樣式
  • 顯示樣式

配置樣式 會影響元件的許多元素,以建立元件的定義良好且可識別的轉譯(設計和配置),通常會對齊特定的可重複使用品牌概念。 例如,Teaser元件可以呈現為傳統卡片式版面、水準促銷樣式,或是在影像上以主圖版面覆蓋文字。

顯示樣式 可用來影響版面樣式的細微變化,但不會改變版面樣式的基本性質或用途。 例如,主圖版面配置樣式可能有顯示樣式,可將色彩配置從主要品牌色彩配置變更為次要品牌色彩配置。

風格組織最佳實務 style-organization-best-practices

在定義AEM作者可用的樣式名稱時,最好:

  • 使用作者能理解的辭彙來命名樣式
  • 最小化樣式選項的數目
  • 僅公開品牌標準允許的樣式選項和組合
  • 僅公開具有效果的樣式組合
    • 如果暴露無效組合,請確定它們至少不會產生不良影響

隨著AEM作者可用的可能樣式組合數量增加,存在更多必須通過QA驗證且符合品牌標準之排列組合。 太多選項也會讓作者感到困惑,因為不知道需要哪個選項或組合才能產生想要的效果。

樣式名稱與CSS類別的比較 style-names-vs-css-classes

樣式名稱,或呈現給AEM作者的選項,以及實作CSS類別名稱在AEM中是分離的。

這可讓樣式選項以清楚的辭彙標示,並讓AEM作者瞭解,但可讓CSS開發人員以未來的校訂、語意方式命名CSS類別。 例如:

元件必須具備可用品牌顏色標籤的選項 主要次要 不過,AEM作者知道的顏色 綠色黃色,而不是主要和次要的設計語言。

AEM樣式系統可使用作者友善的標籤來公開這些著色顯示樣式 綠色黃色,同時允許CSS開發人員使用 .cmp-component--primary-color.cmp-component--secondary-color 以定義CSS中的實際樣式實施。

的樣式名稱 綠色 已對應 .cmp-component--primary-color、和 黃色.cmp-component--secondary-color.

如果公司的品牌色彩在未來有所變更,您只需要下列的單一實作即可 .cmp-component--primary-color.cmp-component--secondary-color和樣式名稱。

Teaser元件作為範例使用案例 the-teaser-component-as-an-example-use-case

以下範例使用案例來設定Teaser元件的樣式,使其具有數個不同的「配置」和「顯示」樣式。

這將會探索樣式名稱(向作者公開)的方式以及支援CSS類別的組織方式。

Teaser元件樣式設定 component-styles-configuration

下圖顯示 樣式 針對使用案例中討論的變異的Teaser元件設定。

此 樣式群組 名稱、版面配置及顯示(依偶然情況)符合本文中用來將樣式型別概念分類的顯示樣式及版面樣式的一般概念。

此 樣式群組 名稱和數量 樣式群組 應針對元件使用案例和專案特定的元件樣式慣例進行量身打造。

例如, 顯示 樣式群組名稱可能已命名 顏色.

顯示樣式群組

樣式選取功能表 style-selection-menu

下圖顯示 樣式 功能表作者可與互動,為元件選取適當的樣式。 請注意 樣式群組 名稱以及樣式名稱都會向作者公開。

樣式下拉式功能表

預設樣式 default-style

預設樣式通常是元件最常用的樣式,以及新增到頁面時預設的Teaser未樣式檢視。

根據預設樣式的通用性,CSS可以直接套用到 .cmp-teaser (沒有任何修飾元)或 .cmp-teaser--default.

如果預設樣式規則套用至所有變數的頻率高於不套用至所有變數,建議您使用 .cmp-teaser 作為預設樣式的CSS類別,因為所有變數都應該隱含地繼承它們,假設遵循BEM之類的約定。 否則應透過預設修飾元套用,例如 .cmp-teaser--default,則需要新增至 元件的樣式設定的預設CSS類別 欄位,否則必須在每個變數中覆寫這些樣式規則。

您甚至可以指派「已命名」的樣式作為預設樣式,例如主圖樣式 (.cmp-teaser--hero) 定義如下,但更清楚的是,要對 .cmp-teaser.cmp-teaser--default CSS類別實作。

NOTE
請注意,「預設」配置樣式沒有「顯示」樣式名稱,但作者可以在「AEM樣式系統」選取工具中選取「顯示」選項。
這違反了最佳實務:
僅公開具有效果的樣式組合
如果作者選取的顯示樣式 綠色 什麼都不會發生。
在此使用案例中,我們將承認此違規,因為所有其他版面樣式都必須可使用品牌顏色上色。
促銷(靠右對齊) 下節將說明如何防止不想要的樣式組合。

預設樣式

  • 配置樣式
    • 預設
  • 顯示樣式
  • 有效的CSS類別.cmp-teaser--promo.cmp-teaser--default

促銷樣式 promo-style

促銷配置樣式 用於促銷網站上的高價值內容,且會水準配置以佔用網頁上的一連串空間,且必須可依品牌顏色搭配樣式(預設的「促銷」配置樣式使用黑色文字)。

達成此目的, 配置樣式促銷顯示樣式綠色黃色 已在AEM樣式系統中為Teaser元件設定。

促銷預設

促銷預設

  • 配置樣式

    • 樣式名稱: 促銷
    • CSS類別: cmp-teaser--promo
  • 顯示樣式

  • 有效的CSS類別.cmp-teaser--promo

主要促銷

主要促銷

  • 配置樣式

    • 樣式名稱: 促銷
    • CSS類別: cmp-teaser--promo
  • 顯示樣式

    • 樣式名稱: 綠色
    • CSS類別: cmp-teaser--primary-color
  • 有效的CSS類別cmp-teaser--promo.cmp-teaser--primary-color

次要促銷

次要促銷

  • 配置樣式

    • 樣式名稱: 促銷
    • CSS類別: cmp-teaser--promo
  • 顯示樣式

    • 樣式名稱: 黃色
    • CSS類別: cmp-teaser--secondary-color
  • 有效的CSS類別cmp-teaser--promo.cmp-teaser--secondary-color

促銷右對齊樣式 promo-r-align

促銷活動靠右對齊 版面配置樣式是「促銷」樣式的變體,樣式會顛倒影像與文字(影像在右,文字在左)的位置。

右對齊方式的核心是顯示樣式,可以將其輸入到「AEM樣式系統」中作為顯示樣式,該顯示樣式與「促銷」配置樣式一起選取。 這違反了以下最佳實務:

僅公開具有效果的樣式組合

…已經違反了 預設樣式.

由於正確對齊方式只會影響「促銷」配置樣式,而不會影響其他2個配置樣式:預設和主圖,因此我們可以建立新的配置樣式「促銷」(Right-aligned),包含將「促銷」配置樣式內容右對齊的CSS類別: cmp -teaser--alternate.

將多個樣式組合成單一樣式專案,也可協助減少可用樣式和樣式排列的數目,使其最少。

注意CSS類別的名稱, cmp-teaser--alternate,不必符合作者友善的「right aligned」命名法。

促銷活動靠右對齊預設值

促銷活動靠右對齊

  • 配置樣式

    • 樣式名稱: 促銷(靠右對齊)
    • CSS類別: cmp-teaser--promo cmp-teaser--alternate
  • 顯示樣式

  • 有效的CSS類別.cmp-teaser--promo.cmp-teaser--alternate

主要促銷活動靠右對齊

主要促銷活動靠右對齊

  • 配置樣式

    • 樣式名稱: 促銷(靠右對齊)
    • CSS類別: cmp-teaser--promo cmp-teaser--alternate
  • 顯示樣式

    • 樣式名稱: 綠色
    • CSS類別: cmp-teaser--primary-color
  • 有效的CSS類別.cmp-teaser--promo.cmp-teaser--alternate.cmp-teaser--primary-color

促銷右對齊次要

促銷右對齊次要

  • 配置樣式

    • 樣式名稱: 促銷(靠右對齊)
    • CSS類別: cmp-teaser--promo cmp-teaser--alternate
  • 顯示樣式

    • 樣式名稱: 黃色
    • CSS類別: cmp-teaser--secondary-color
  • 有效的CSS類別.cmp-teaser--promo.cmp-teaser--alternate.cmp-teaser--secondary-color

英雄樣式 hero-style

主圖版面配置樣式會將元件的影像顯示為背景,並覆蓋標題和連結。 主圖版面配置樣式(如促銷版面配置樣式)必須可搭配品牌顏色上色。

若要以品牌色彩為主圖版面樣式上色,可運用與促銷版面樣式相同的顯示樣式。

每個元件中,樣式名稱會對應至單一CSS類別集,這表示代表Promo配置樣式背景的CSS類別名稱必須代表Hero配置樣式的文字和連結。

只要界定CSS規則的範圍,通常就能達成此目的,不過,這確實需要CSS開發人員瞭解這些排列如何在AEM上實施。

用於為背景著色的CSS 提升 主要顏色(綠色)的版面配置樣式:

.cmp-teaser--promo.cmp-teaser--primary--color {
   ...
   background-color: green;
   ...
}

用於為文字著色的CSS Hero 主要顏色(綠色)的版面配置樣式:

.cmp-teaser--hero.cmp-teaser--primary--color {
   ...
   color: green;
   ...
}

Hero預設

英雄樣式

  • 配置樣式

    • 樣式名稱: Hero
    • CSS類別: cmp-teaser--hero
  • 顯示樣式

  • 有效的CSS類別.cmp-teaser--hero

主要主圖

主要主圖

  • 配置樣式

    • 樣式名稱: 促銷
    • CSS類別: cmp-teaser--hero
  • 顯示樣式

    • 樣式名稱: 綠色
    • CSS類別: cmp-teaser--primary-color
  • 有效的CSS類別cmp-teaser--hero.cmp-teaser--primary-color

主圖次要

主圖次要

  • 配置樣式

    • 樣式名稱: 促銷
    • CSS類別: cmp-teaser--hero
  • 顯示樣式

    • 樣式名稱: 黃色
    • CSS類別: cmp-teaser--secondary-color
  • 有效的CSS類別cmp-teaser--hero.cmp-teaser--secondary-color

其他資源 additional-resources

recommendation-more-help
bb44cebf-d964-4e3c-b64e-ce882243fe4d