了解样式系统最佳实践 understanding-style-organization-with-the-aem-style-system
AEM Style System有两种主要风格或样式:
- 布局样式
- 显示样式
布局样式 会影响组件的许多元素,以创建组件的定义良好且可识别的演绎版(设计和布局),通常与特定的可重复使用的品牌概念保持一致。 例如,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组件的样式配置。
样式组名称、布局和显示(按偶然情况)与本文中用于为样式类型进行概念分类的显示样式和布局样式的一般概念匹配。
样式组名称和样式组的数量应该根据组件用例和项目特定的组件样式约定来定制。
例如,Display 样式组名称可能已命名为 Colors。
样式选择菜单 style-selection-menu
下图显示了样式菜单作者与之交互以为组件选择适当的样式。 请注意,样式Grpi名称以及样式名称均向作者公开。
默认样式 default-style
默认样式通常是组件最常用的样式,以及在添加到页面时Teaser的默认无样式视图。
根据默认样式的通用性,CSS可以直接应用于.cmp-teaser
(没有任何修饰符)或.cmp-teaser--default
。
如果默认样式规则更常应用于所有变体,则最好使用.cmp-teaser
作为默认样式的CSS类,因为所有变体都应隐式继承它们(假定遵循类似BEM的约定)。 如果不适用,则应通过默认修饰符(如.cmp-teaser--default
)来应用这些变量,而默认修饰符又需要添加到组件的样式配置的默认CSS类字段中,否则必须在每个变量中覆盖这些样式规则。
甚至可以将“named”样式指定为默认样式,例如,下面定义的Hero样式(.cmp-teaser--hero)
,但更明确的是,应针对.cmp-teaser
或.cmp-teaser--default
CSS类实施默认样式。
- 布局样式
- 默认
- 显示样式
- 无
- 有效的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个布局样式:默认样式和主页样式,因此我们可以创建新的布局样式“促销”(右对齐),其中包括对“促销”布局样式内容进行右对齐的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类,这意味着为促销布局样式的背景着色的CSS类名称必须为主页布局样式的文本和链接着色。
可以通过设定CSS规则的范围轻松实现此目标,但是,这要求CSS开发人员了解这些排列如何在AEM上实施。
用于将 Promote 布局样式的背景用主(绿色)颜色着色的CSS:
.cmp-teaser--promo.cmp-teaser--primary--color {
...
background-color: green;
...
}
用于将 Hero 布局样式的文本用主(绿色)颜色着色的CSS:
.cmp-teaser--hero.cmp-teaser--primary--color {
...
color: green;
...
}
主页默认值
-
布局样式
- 样式名称: 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