CSS / Sass 规范指南

目录

术语

规则声明

我们把一个（或一组）选择器和一组属性称之为 “规则声明”。举个例子：

  1. .listing {
  2.   font-size: 18px;
  3.   line-height: 1.2;
  4. }

选择器

在规则声明中，“选择器” 负责选取 DOM 树中的元素，这些元素将被定义的属性所修饰。选择器可以匹配 HTML 元素，也可以匹配一个元素的类名、ID, 或者元素拥有的属性。以下是选择器的例子：

  1. .my-element-class {
  2.   /* ... */
  3. }
  5. [aria-hidden] {
  6.   /* ... */
  7. }

属性

最后，属性决定了规则声明里被选择的元素将得到何种样式。属性以键值对形式存在，一个规则声明可以包含一或多个属性定义。以下是属性定义的例子：

  1. /* some selector */ {
  2.   background: #f1f1f1;
  3.   color: #333;
  4. }

CSS

文件引用

  • [建议] 使用 link 的方式调用外部样式
  • [强制] 不允许在 <style> 块中使用 @import。
  • [强制] 不允许使用 style 属性写行内样式。

格式

  • [强制] 使用 2 个空格作为缩进。
  • [强制] 全小写，使用-作为相关类的自然间断（不要使用_和 camelCase）。
  • [建议] 不要使用 ID 选择器。
  • [强制] 在一个规则声明中应用了多个选择器时，每个选择器独占一行。
  • [强制] 在规则声明的左大括号 { 前加上一个空格。
  • [强制] 在属性的冒号 : 后面加上一个空格，前面不允许空格。
  • [强制] 逗号分隔的取值，都应该在逗号之后增加一个空格
  • [强制] 规则声明的右大括号 } 独占一行。
  • [建议] 规则声明之间用空行分隔开。
  • [建议] 每个选择器最后一条属性 ; 不能省略
  • [建议] 所有的十六进制值都应该使用小写字母，例如 #fff
  • [强制] 为选择器中得属性取值添加双引号，例如 input[type="text"]
  • [建议] 不要为 0 指明单位，比如使用 margin: 0; 而不是 margin: 0px;
  • [建议] 在定义无边框样式时，使用 0 代替 none。

Bad

  1. .avatar{
  2.     border-radius:50%;
  3.     border:2px solid white; }
  4. .no, .nope, .not_good {
  5.     // ...
  6. }
  7. #lol-no {
  8.   // ...
  9. }

Good

  1. .avatar {
  2.   border-radius: 50%;
  3.   border: 2px solid white;
  4. }
  6. .one,
  7. .selector,
  8. .per-line {
  9.   // ...
  10. }

属性顺序

  1. Positioning
  2. Box model 盒模型
  3. Typographic 排版
  4. Visual 外观

Position 处在第一位，因为他可以使一个元素脱离正常文本流，独立显示，并且覆盖盒模型相关的样式。盒模型紧跟其后，因为他决定了一个组件的大小和位置。

  1. .declaration-order {
  2.   /* Positioning */
  3.   position: absolute;
  4.   top: 0;
  5.   right: 0;
  6.   bottom: 0;
  7.   left: 0;
  8.   z-index: 100;
  10.   /* Box-model */
  11.   display: block;
  12.   float: right;
  13.   width: 100px;
  14.   height: 100px;
  16.   /* Typography */
  17.   font: normal 13px "Helvetica Neue", sans-serif;
  18.   line-height: 1.5;
  19.   color: #333;
  20.   text-align: center;
  22.   /* Visual */
  23.   background-color: #f5f5f5;
  24.   border: 1px solid #e5e5e5;
  25.   border-radius: 3px;
  27.   /* Misc */
  28.   opacity: 1;
  29. }

注意事项

  • [强制] 避免过度使用简写。.btn 可以很好地描述 button，但是 .s 不能代表任何元素。
  • [建议] class 的命名应该尽量短，也要尽量明确。
  • [强制] 使用有意义的名称；使用结构化或者作用目标相关，而不是抽象的名称。
  • [建议] 命名时使用最近的父节点或者父 class 作为前缀。
  • [强制] 使用 classes 而不是通用元素作为选择器，不允许 div.doc。
  • [建议] 避免在经常出现的组件中使用一些属性选择器 (例如，[class^=”…”])。浏览器性能会受到这些情况的影响。
  • [建议] 减少选择器的长度，每个组合选择器选择器的条目应该尽量控制在 3 个以内。

注释

  • 建议使用行注释 (在 Sass 中是 //) 代替块注释。
  • 建议注释独占一行。避免行末注释。
  • 保持注释内容与星号之间有一个空格的距离 /* 普通注释 */
  • 给没有自注释的代码写上详细说明，比如：
    • 为什么用到了 z-index
    • 兼容性处理或者针对特定浏览器的 hack

OOCSS 和 BEM

出于以下原因，建议使用 OOCSS 和 BEM 的某种组合：

  • 可以帮助我们理清 CSS 和 HTML 之间清晰且严谨的关系。
  • 可以帮助我们创建出可重用、易装配的组件。
  • 可以减少嵌套，降低特定性。
  • 可以帮助我们创建出可扩展的样式表。

OOCSS，也就是 “Object Oriented CSS（面向对象的CSS）”，是一种写 CSS 的方法，其思想就是鼓励你把样式表看作“对象”的集合：创建可重用性、可重复性的代码段让你可以在整个网站中多次使用。

参考资料：

BEM，也就是 “Block-Element-Modifier”，是一种用于 HTML 和 CSS 类名的命名约定。BEM 最初是由 Yandex 提出的，要知道他们拥有巨大的代码库和可伸缩性，BEM 就是为此而生的，并且可以作为一套遵循 OOCSS 的参考指导规范。

示例

  1. <article class="listing-card listing-card--featured">
  3.   <h1 class="listing-card__title">Adorable 2BR in the sunny Mission</h1>
  5.   <div class="listing-card__content">
  6.     <p>Vestibulum id ligula porta felis euismod semper.</p>
  7.   </div>
  9. </article>
  1. .listing-card { }
  2. .listing-card--featured { }
  3. .listing-card__title { }
  4. .listing-card__content { }
  • .listing-card 是一个块（block），表示高层次的组件。
  • .listing-card__title 是一个元素（element），它属于 .listing-card 的一部分，因此块是由元素组成的。
  • .listing-card--featured 是一个修饰符（modifier），表示这个块与 .listing-card 有着不同的状态或者变化。

ID 选择器

在 CSS 中，虽然可以通过 ID 选择元素，但大家通常都会把这种方式列为反面教材。ID 选择器给你的规则声明带来了不必要的高优先级，而且 ID 选择器是不可重用的。

想要了解关于这个主题的更多内容，参见 CSS Wizardry 的文章，文章中有关于如何处理优先级的内容。

JavaScript 钩子

避免在 CSS 和 JavaScript 中绑定相同的类。否则开发者在重构时通常会出现以下情况：轻则浪费时间在对照查找每个要改变的类，重则因为害怕破坏功能而不敢作出更改。

我们推荐在创建用于特定 JavaScript 的类名时，添加 .js- 前缀：

  1. <button class="btn btn-primary js-request-to-book">Request to Book</button>

Sass

语法

  • 使用 .scss 的语法，不使用 .sass 原本的语法。
  • CSS 和 @include 声明按照以下逻辑排序（参见下文）

属性声明的排序

  1. 属性声明

    首先列出除去 @include 和嵌套选择器之外的所有属性声明。

    1.  .btn-green {
    2.    background: green;
    3.    font-weight: bold;
    4.    // ...
    5.  }

  2. @include 声明

    紧随后面的是 @include，这样可以使得整个选择器的可读性更高。

    1.  .btn-green {
    2.    background: green;
    3.    font-weight: bold;
    4.    @include transition(background 0.5s ease);
    5.    // ...
    6.  }

  3. 嵌套选择器

    如果有必要用到嵌套选择器，把它们放到最后，在规则声明和嵌套选择器之间要加上空白，相邻嵌套选择器之间也要加上空白。嵌套选择器中的内容也要遵循上述指引。

    1.  .btn {
    2.    background: green;
    3.    font-weight: bold;
    4.    @include transition(background 0.5s ease);
    6.    .icon {
    7.      margin-right: 10px;
    8.    }
    9.  }

变量

变量名应使用破折号（例如 $my-variable）代替 camelCased 和 snake_cased 风格。对于仅用在当前文件的变量，可以在变量名之前添加下划线前缀（例如 $_my-variable）。

Mixins

为了让代码遵循 DRY 原则（Don’t Repeat Yourself）、增强清晰性或抽象化复杂性，应该使用 mixin，这与那些命名良好的函数的作用是异曲同工的。虽然 mixin 可以不接收参数，但要注意，假如你不压缩负载（比如通过 gzip），这样会导致最终的样式包含不必要的代码重复。

扩展指令

应避免使用 @extend 指令，因为它并不直观，而且具有潜在风险，特别是用在嵌套选择器的时候。即便是在顶层占位符选择器使用扩展，如果选择器的顺序最终会改变，也可能会导致问题。（比如，如果它们存在于其他文件，而加载顺序发生了变化）。其实，使用 @extend 所获得的大部分优化效果，gzip 压缩已经帮助你做到了，因此你只需要通过 mixin 让样式表更符合 DRY 原则就足够了。

嵌套选择器

请不要让嵌套选择器的深度超过 3 层！

  1. .page-container {
  2.   .content {
  3.     .profile {
  4.       // STOP!
  5.     }
  6.   }
  7. }

当遇到以上情况的时候，你也许是这样写 CSS 的：

  • 与 HTML 强耦合的（也是脆弱的）—或者—
  • 过于具体（强大）—或者—
  • 没有重用

再说一遍: 永远不要嵌套 ID 选择器！

如果你始终坚持要使用 ID 选择器（劝你三思），那也不应该嵌套它们。如果你正打算这么做，你需要先重新检查你的标签，或者指明原因。如果你想要写出风格良好的 HTML 和 CSS，你是不应该这样做的。