了解样式系统最佳实践

注意

请在 了解如何对样式系统进行代码,以确保了解AEM样式系统使用的类似BEM的约定。

AEM样式系统主要实施两种风格或样式:

  • 布局样式
  • 显示样式

布局样式 会影响组件的许多元素,以便创建组件的良好定义和可识别呈现版本(设计和布局),通常与特定的可重复使用的品牌概念保持一致。 例如,Teaser组件可以采用传统的基于卡的布局、水平促销样式或作为在图像上叠加文本的Hero布局来呈现。

显示样式 布局样式的细微变化都会被使用,但是,它们不会更改布局样式的基本性质或意图。 例如,“主页”布局样式可能具有将颜色方案从主品牌颜色方案更改为次品牌颜色方案的“显示”样式。

样式组织最佳实践

定义AEM作者可用的样式名称时,最好执行以下操作:

  • 使用作者所理解的词汇命名样式
  • 最大限度地减少样式选项的数量
  • 仅显示品牌标准允许的样式选项和组合
  • 仅显示有效的样式组合
    • 如果暴露无效组合,请确保它们至少不会产生不良影响

随着AEM作者可用的可能样式组合的数量增加,必须根据品牌标准进行QA和验证的排列组合也会越多。 太多的选项也会令作者感到困惑,因为不清楚需要哪个选项或组合才能产生所需的效果。

样式名称与CSS类

样式名称或呈现给AEM作者的选项,以及实施CSS类名称在AEM中是相互分离的。

这允许样式选项以词汇清晰的方式进行标记,并且AEM作者可以理解该选项,但允许CSS开发人员以未来的语义方式命名CSS类。 例如:

组件必须具有用品牌颜色显示的选项 主要辅助 但是,AEM作者将颜色称为 绿色黄色,而不是主要和次要的设计语言。

AEM样式系统可以使用对作者友好的标签来显示这些着色显示样式 绿色黄色,同时允许CSS开发人员使用的语义命名 .cmp-component--primary-color.cmp-component--secondary-color 定义CSS中的实际样式实施。

的样式名称 绿色 映射到 .cmp-component--primary-color黄色 to .cmp-component--secondary-color.

如果公司的品牌颜色在未来发生更改,则只需实施 .cmp-component--primary-color.cmp-component--secondary-color、和样式名称。

Teaser组件作为示例用例

以下示例用例为Teaser组件设置样式,使其具有多个不同的布局和显示样式。

这将探索样式名称(向作者公开)的组织方式以及备用CSS类的组织方式。

Teaser组件样式配置

下图显示了 样式 用于用例中讨论的变体的Teaser组件配置。

的 样式组 名称、布局和显示(按偶然情况)与显示样式和布局样式的一般概念匹配,后者用于从概念上对本文中的样式类型进行分类。

的 样式组 名称和数量 样式组 应根据组件用例和特定于项目的组件样式约定进行定制。

例如, 显示 样式组名称可以命名 颜色.

显示样式组

样式选择菜单

下图显示了 样式 菜单作者可与之交互,以为组件选择适当的样式。 请注意 样式网格 名称以及样式名称都会向作者显示。

样式下拉菜单

默认样式

默认样式通常是组件最常用的样式,而Teaser添加到页面时的默认未设置样式视图。

根据默认样式的通用性,CSS可以直接在 .cmp-teaser (不含任何修饰符)或 .cmp-teaser--default.

如果默认样式规则应用于所有变体的频率高于不应用于所有变量,则最好使用 .cmp-teaser 作为默认样式的CSS类,因为所有变体都应隐式继承它们,这假定遵循BEM类惯例。 如果没有,则应通过默认修饰符应用,例如 .cmp-teaser--default,这反过来又需要添加到 组件的样式配置的默认CSS类 字段,否则,这些样式规则必须在每个变体中被覆盖。

甚至可以指定“已命名”样式作为默认样式,例如“主页”样式 (.cmp-teaser--hero) 下定义,但更清楚的是,应对 .cmp-teaser.cmp-teaser--default CSS类实现。

注意

请注意,默认布局样式没有显示样式名称,但作者可以在AEM样式系统选择工具中选择显示选项。

这违反了最佳做法:

仅显示有效的样式组合

如果作者选择的显示样式为 绿色 什么也不会发生。

在此用例中,我们将承认此违规,因为所有其他布局样式都必须使用品牌颜色可着色。

促销(右对齐) 下面的部分将介绍如何防止不需要的样式组合。

默认样式

  • 布局样式
    • 默认
  • 显示样式
  • 有效的CSS类: .cmp-teaser--promo.cmp-teaser--default

促销样式

促销活动布局样式 用于在网站上促销高价值内容,并水平排列以占用网页上的一段空间,且必须按品牌颜色显示样式,默认的促销活动布局样式为使用黑色文本。

实现此目的, 布局样式 of 促销显示样式 of 绿色黄色 在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

促销右对齐样式

促销右对齐 布局样式是促销活动样式的一个变体,该样式会翻转图像和文本的位置(图像位于右侧,文本位于左侧)。

右对齐的核心是显示样式,可以将其作为与促销活动布局样式一起选择的显示样式输入AEM样式系统中。 这违反了以下最佳实践:

仅显示有效的样式组合

…在 默认样式.

由于右对齐仅影响促销活动布局样式,而不会影响其他2种布局样式:默认和主页,我们可以创建新的布局样式促销(右对齐),它包含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布局样式(与Promo布局样式类似)必须可以使用品牌颜色着色。

要使用品牌颜色为Hero布局样式设置颜色,可以使用与促销活动布局样式相同的显示样式。

对于每个组件,样式名称会映射到一组CSS类,这意味着为促销活动布局样式背景设置颜色的CSS类名称必须为Hero布局样式的文本和链接设置颜色。

通过范围化CSS规则可以轻松实现这一点,但是,这确实要求CSS开发人员了解如何在AEM中实施这些排列。

用于为背景着色的CSS 提升 具有主(绿色)颜色的布局样式:

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

用于为的文本着色的CSS 英雄 具有主(绿色)颜色的布局样式:

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

主页默认

英雄风格

  • 布局样式
    • 样式名称: 英雄
    • 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

其他资源

在此页面上