CSS编码规范

853 阅读18分钟

CSS编码规范

目录

前言

是网页样式的描述语言。本文档的目标是使 CSS 代码风格保持一致,容易被理解和被维护。 虽然本文档是针对 CSS 设计的,但是在使用各种 CSS 的预编译器(如 less、sass、stylus 等)时,适用的部分也应尽量遵循本文档的约定。

样式类型

  1. 行间
    • 直接在标签上书写CSS样式
  2. 外部
    • 通过link引入外部样式文件
  3. 内联
    • 通过style书写与页面head标签内

CSS选择器类型

  1. ID  #id
  2. class  .class
  3. 标签  p
  4. 通用  *
  5. 属性  [type="text"]
  6. 伪类  :hover
  7. 伪元素  ::first-line
  8. 子选择器、相邻选择器

权重计算规则

  1. 一等:代表内联样式,如: style=””,权值为1000。
  2. 二等:代表ID选择器,如:#content,权值为0100。
  3. 三等:代表类,伪类和属性选择器,如.content,权值为0010。
  4. 四等:代表类型选择器和伪元素选择器,如div p,权值为0001。
  5. 通配符、子选择器、相邻选择器等的。如*、>、+,权值为0000。
  6. 继承的样式没有权值。

比较规则

  1. 选择器都有一个权值,权值越大越优先;
  2. 当权值相等时,后出现的样式表设置要优于先出现的样式表设置;
  3. 创作者的规则高于浏览者:即网页编写者设置的 CSS 样式的优先权高于浏览器所设置的样式;
  4. 继承的 CSS 样式不如后来指定的 CSS 样式;
  5. 在同一组属性设置中标有!important规则的优先级最大
  6. 通配符、子选择器、相邻选择器等的。虽然权值为0000,但是也比继承的样式优先。

important

  1. !important 的作用是提升优先级,换句话说。加了这句的样式的优先级是最高的(比内联样式的优先级还高)。
  2. ie7+和别的浏览器对important的这种作用的支持度都很好。只有ie6有些bug
  3. [建议] 尽量不使用 !important 声明。
  4. [建议] 当需要强制指定样式且不允许任何场景覆盖时,通过标签内联和 !important 定义样式。。
    • 解释:必须注意的是,仅在设计上 确实不允许任何其它场景覆盖样式 时,才使用内联的 !important 样式。通常在第三方环境的应用中使用这种方案。下面的 z-index 章节是其中一个特殊场景的典型样例。

⬆️ 🏠返回顶部

Sass

Deep

vue中的css深度选择器 :deep()、/deep/、>>>、::v-deep 到底是什么?

  1. vueLoader-深度作用选择器

概念与作用

<style> 标签有 scoped 属性时,它的 CSS 只作用于当前组件中的元素,父组件的样式将不会渗透到子组件。 如果你希望 scoped 样式中的一个选择器能够作用得“更深”,例如影响子组件,你可以使用深度选择器。

例子:

<template> 

    <div class="not-found"> 

        <a-card title="Card title"> 

            <p>Card content</p> 

            <p>Card content</p> 

            <p>Card content</p> 

        </a-card> 

    </div> 

</template>显然,由于scoped属性的防渗透作用,我添加的背景色并不会生效。通常,会有两种处理方法:

这是vue项目中通常会看到的一个page文件,我在其中引用了ant-design-vue 的 a-card 组件, 我希望在这个page文件中,a-card组件的标题为绿色,于是我找到a-card组件title对应的class值,添加了如下样式代码:

<style lang="scss" scoped>

  .ant-card-head-title{

    background: yellowgreen;

  }

</style>

显然,由于scoped属性的防渗透作用,我添加的背景色并不会生效。通常,会有两种处理方法:

  1. 将scoped属性去掉。样式生效了,但是这种写法是作用到全局的,如果不严格规范class的命名,非常容易污染全局样式。这种写法,其实等同于写在全局样式文件中
  2. 保留scoped属性,使用深度选择器,代码如下
<style lang="scss" scoped>



  :deep(.ant-card-head-title){

    background: yellowgreen;

  }

</style>

查看浏览器,以上代码被编译成

[data-v-e44d851a] .ant-card-head-title{  

    background: yellowgreen;

}

很明显,添加了这个属性之后,可以达到我们想要的效果,而且不会污染全局样式

 <!-- 写法1 使用::v-deep --> 

<style lang="scss" scoped> 

  ::v-deep .ant-card-head-title{ background: yellowgreen; } 

</style> 

 <!-- 写法2 使用>>> 操作符--> 

<style scoped> 

  >>>.ant-card-head-title{ background: yellowgreen; } 

</style> 

 <!-- 写法3 使用/deep/ --> 

<style scoped> 

  /deep/.ant-card-head-title{ background: yellowgreen; } 

</style> 

 <!-- 写法4 使用:deep(<inner-selector>) --> 

<style lang="scss" scoped> 

  :deep(.ant-card-head-title){ background: yellowgreen; } 

</style>

写法1 和写法4,都支持sass预处理器。但是在新的vue3.0 单文件规范中,如果你还是使用写法1,会碰到如下警告:

 [@vue/compiler-sfc]  ::v-deep usage as a combinator has been deprecated. Use  :deep(<inner-selector>)  instead.

写法1在vue3.0中已经被弃用了,以后小伙伴们在开发vue3.0项目的时候,还是使用写法4吧~,有一说一,写法4在语义上也更有助于理解。

关于写法1和写法3,主要是不支持sass预处理器的解析,且>>>操作符存在浏览器兼容性问题,所以还是谨慎使用吧~

语法

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

属性声明的排序

  1. 属性声明

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

.btn-green {
  background: green;
  font-weight: bold;
  // ...
}
  1. @include 声明

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

.btn-green {
  background: green;
  font-weight: bold;
  @include transition(background 0.5s ease);
  // ...
}
  1. 嵌套选择器

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

.btn {
  background: green;
  font-weight: bold;
  @include transition(background 0.5s ease);

  .icon {
    margin-right: 10px;
  }
}

变量

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

mixins

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

扩展指令

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

嵌套选择器

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

.page-container {
  .content {
    .profile {
      // STOP!
    }
  }
}

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

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

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

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

⬆️ 🏠返回顶部

代码风格

文件

[建议] CSS 文件使用无 BOM 的 UTF-8 编码。 解释: UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。

缩进

[强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。 示例:

.selector {
    margin: 0;
    padding: 0;
}

空格

[强制] 选择器 与 { 之间必须包含空格。

示例:

.selector {
}

[强制] 属性名 与之后的 : 之间不允许包含空格, : 与 属性值 之间必须包含空格。

示例:

margin: 0;

[强制] 列表型属性值 书写在单行时, 后必须跟一个空格。

示例:

font-family: Arial, sans-serif;

行长度

[强制] 每行不得超过 120 个字符,除非单行不可分割。

解释:

常见不可分割的场景为URL超长。 [建议] 对于超长的样式,在样式值的 空格 处或 , 后换行,建议按逻辑分组。

示例:

/* 不同属性值按逻辑分组 */
background:
    transparent url(aVeryVeryVeryLongUrlIsPlacedHere)
    no-repeat 0 0;

/* 可重复多次的属性,每次重复一行 */
background-image:
    url(aVeryVeryVeryLongUrlIsPlacedHere)
    url(anotherVeryVeryVeryLongUrlIsPlacedHere);

/* 类似函数的属性值可以根据函数调用的缩进进行 */
background-image: -webkit-gradient(
    linear,
    left bottom,
    left top,
    color-stop(0.04, rgb(88,94,124)),
    color-stop(0.52, rgb(115,123,162))
);

选择器

[强制] 当一个 rule 包含多个 selector 时,每个选择器声明必须独占一行。

示例:

/* good */
.post,
.page,
.comment {
    line-height: 1.5;
}

/* bad */
.post, .page, .comment {
    line-height: 1.5;
}

[强制] >、+、~ 选择器的两边各保留一个空格。

示例:

/* good */
main > nav {
    padding: 10px;
}

label + input {
    margin-left: 5px;
}

input:checked ~ button {
    background-color: #69C;
}

/* bad */
main>nav {
    padding: 10px;
}

label+input {
    margin-left: 5px;
}

input:checked~button {
    background-color: #69C;
}

[强制] 属性选择器中的值必须用双引号包围。

解释: 不允许使用单引号,不允许不使用引号。

示例:

/* good */
article[character="juliet"] {
    voice-family: "Vivien Leigh", victoria, female;
}

/* bad */
article[character='juliet'] {
    voice-family: "Vivien Leigh", victoria, female;
}

属性

[强制] 属性定义必须另起一行。

示例:

/* good */
.selector {
    margin: 0;
    padding: 0;
}

/* bad */
.selector { margin: 0; padding: 0; }

[强制] 属性定义后必须以分号结尾。

示例:

/* good */
.selector {
    margin: 0;
}

/* bad */
.selector {
    margin: 0
}

⬆️ 🏠返回顶部

通用

选择器

[强制] 如无必要,不得为 id、class 选择器添加类型选择器进行限定。

解释: 在性能和维护性上,都有一定的影响。

示例:

/* good */
#error,
.danger-message {
    font-color: #c00;
}

/* bad */
dialog#error,
p.danger-message {
    font-color: #c00;
}

[建议] 选择器的嵌套层级应不大于 3 级,位置靠后的限定条件应尽可能精确。

示例:

/* good */
#username input {}
.comment .avatar {}

/* bad */
.page .header .login #username input {}
.comment div * {}

属性缩写

[建议] 在可以使用缩写的情况下,尽量使用属性缩写。

示例:

/* good */
.post {
    font: 12px/1.5 arial, sans-serif;
}

/* bad */
.post {
    font-family: arial, sans-serif;
    font-size: 12px;
    line-height: 1.5;
}

[建议] 使用 border / margin / padding

等缩写时,应注意隐含值对实际数值的影响,确实需要设置多个方向的值时才使用缩写。

解释: border / margin / padding等缩写会同时设置多个属性的值,容易覆盖不需要覆盖的设定。如某些方向需要继承其他声明的值,则应该分开设置。

示例:

/* centering <article class="page"> horizontally and highlight featured ones */
article {
    margin: 5px;
    border: 1px solid #999;
}

/* good */
.page {
    margin-right: auto;
    margin-left: auto;
}

.featured {
    border-color: #69c;
}

/* bad */
.page {
    margin: 5px auto; /* introducing redundancy */
}

.featured {
    border: 1px solid #69c; /* introducing redundancy */
}

属性书写顺序

[建议] 同一 rule set 下的属性在书写时,应按功能进行分组,并以 Formatting Model(布局方式、位置) > Box Model(尺寸) > Typographic(文本相关) > Visual(视觉效果) 的顺序书写,以提高代码的可读性。

解释:

  • Formatting Model 相关属性包括:position / top / right / bottom / left / float / display / overflow 等
  • Box Model 相关属性包括:border / margin / padding / width / height 等
  • Typographic 相关属性包括:font / line-height / text-align / word-wrap 等
  • Visual 相关属性包括:background / color / transition / list-style 等
  • 另外,如果包含 content 属性,应放在最前面。

示例:

.sidebar {
    /* formatting model: positioning schemes / offsets / z-indexes / display / ...  */
    position: absolute;
    top: 50px;
    left: 0;
    overflow-x: hidden;

    /* box model: sizes / margins / paddings / borders / ...  */
    width: 200px;
    padding: 5px;
    border: 1px solid #ddd;

    /* typographic: font / aligns / text styles / ... */
    font-size: 14px;
    line-height: 20px;

    /* visual: colors / shadows / gradients / ... */
    background: #f5f5f5;
    color: #333;
    -webkit-transition: color 1s;
       -moz-transition: color 1s;
            transition: color 1s;
}

清除浮动

[建议] 当元素需要撑起高度以包含内部的浮动元素时,通过对伪类设置 clear 或触发 BFC 的方式进行 clearfix。尽量不使用增加空标签的方式。

解释: 触发 BFC 的方式很多,常见的有:

  • float 非 none
  • position 非 static
  • overflow 非 visible
  • 另需注意,对已经触发 BFC 的元素不需要再进行 clearfix。

z-index

  • [建议] 将 z-index 进行分层,对文档流外绝对定位元素的视觉层级关系进行管理。
    • 解释: 同层的多个元素,如多个由用户输入触发的 Dialog,在该层级内使用相同的 z-index 或递增 z-index。 建议每层包含100个 z-index 来容纳足够的元素,如果每层元素较多,可以调整这个数值。
  • [建议] 在可控环境下,期望显示在最上层的元素,z-index 指定为 999999。
    • 解释:
      • 可控环境分成两种,一种是自身产品线环境;还有一种是可能会被其他产品线引用,但是不会被外部第三方的产品引用。
      • 不建议取值为 2147483647。以便于自身产品线被其他产品线引用时,当遇到层级覆盖冲突的情况,留出向上调整的空间。
  • [建议] 在第三方环境下,期望显示在最上层的元素,通过标签内联和 !important,将 z-index 指定为 2147483647。
  • 解释:第三方环境对于开发者来说完全不可控。在第三方环境下的元素,为了保证元素不被其页面其他样式定义覆盖,需要采用此做法。

值与单位

文本

[强制] 文本内容必须用双引号包围。 解释:文本类型的内容可能在选择器、属性值等内容中。

示例:

/* good */
html[lang|="zh"] q:before {
    font-family: "Microsoft YaHei", sans-serif;
    content: "“";
}

html[lang|="zh"] q:after {
    font-family: "Microsoft YaHei", sans-serif;
    content: "”";
}

/* bad */
html[lang|=zh] q:before {
    font-family: 'Microsoft YaHei', sans-serif;
    content: '“';
}

html[lang|=zh] q:after {
    font-family: "Microsoft YaHei", sans-serif;
    content: "”";
}

⬆️ 🏠返回顶部

值与单位

数值

[强制] 当数值为 0 - 1 之间的小数时,省略整数部分的 0。

示例:

/* good */
panel {
    opacity: .8;
}

/* bad */
panel {
    opacity: 0.8;
}

url()

[强制] url() 函数中的路径不加引号。

示例:

body {
    background: url(bg.png);
}

[建议] url() 函数中的绝对路径可省去协议名。

示例:

body {
    background: url(//baidu.com/img/bg.png) no-repeat 0 0;
}

长度

[强制] 长度为 0 时须省略单位。 (也只有长度单位可省)

示例:

/* good */
body {
    padding: 0 5px;
}

/* bad */
body {
    padding: 0px 5px;
}

颜色

[强制] RGB颜色值必须使用十六进制记号形式 #rrggbb。不允许使用 rgb()。

解释:带有alpha的颜色信息可以使用 rgba()。使用 rgba() 时每个逗号后必须保留一个空格。

示例:

/* good */
.success {
    box-shadow: 0 0 2px rgba(0, 128, 0, .3);
    border-color: #008000;
}

/* bad */
.success {
    box-shadow: 0 0 2px rgba(0,128,0,.3);
    border-color: rgb(0, 128, 0);
}

[强制] 颜色值可以缩写时,必须使用缩写形式。

示例:

/* good */
.success {
    background-color: #aca;
}

/* bad */
.success {
    background-color: #aaccaa;
}

[强制] 颜色值不允许使用命名色值。

示例:

/* good */
.success {
    color: #90ee90;
}

/* bad */
.success {
    color: lightgreen;
}

[建议] 颜色值中的英文字符采用小写。如不用小写也需要保证同一项目内保持大小写一致。

示例:

/* good */
.success {
    background-color: #aca;
    color: #90ee90;
}

/* good */
.success {
    background-color: #ACA;
    color: #90EE90;
}

/* bad */
.success {
    background-color: #ACA;
    color: #90ee90;
}

2D 位置

[强制] 必须同时给出水平和垂直方向的位置。

解释: 2D 位置初始值为 0% 0%,但在只有一个方向的值时,另一个方向的值会被解析为 center。为避免理解上的困扰,应同时给出两个方向的值。

示例:

/* good */
body {
    background-position: center top; /* 50% 0% */
}

/* bad */
body {
    background-position: top; /* 50% 0% */
}

⬆️ 🏠返回顶部

文本编排

字体族

[强制] font-family 属性中的字体族名称应使用字体的英文 Family Name,其中如有空格,须放置在引号中。

解释:

  • 所谓英文 Family Name,为字体文件的一个元数据,常见名称如下:
    • 字体 操作系统 Family Name
    • 宋体 (中易宋体) Windows SimSun
    • 黑体 (中易黑体) Windows SimHei
    • 微软雅黑 Windows Microsoft YaHei
    • 微软正黑 Windows Microsoft JhengHei
    • 华文黑体 Mac/iOS STHeiti
    • 冬青黑体 Mac/iOS Hiragino Sans GB
    • 文泉驿正黑 Linux WenQuanYi Zen Hei
    • 文泉驿微米黑 Linux WenQuanYi Micro Hei 示例: h1 { font-family: "Microsoft YaHei"; } [强制] font-family 按「西文字体在前、中文字体在后」、「效果佳 (质量高/更能满足需求) 的字体在前、效果一般的字体在后」的顺序编写,最后必须指定一个通用字体族( serif / sans-serif )。

解释:更详细说明可参考本文。

示例:

/* Display according to platform */
.article {
    font-family: Arial, sans-serif;
}

/* Specific for most platforms */
h1 {
    font-family: "Helvetica Neue", Arial, "Hiragino Sans GB", "WenQuanYi Micro Hei", "Microsoft YaHei", sans-serif;
}

[强制] font-family 不区分大小写,但在同一个项目中,同样的 Family Name 大小写必须统一。

示例:

/* good */
body {
    font-family: Arial, sans-serif;
}

h1 {
    font-family: Arial, "Microsoft YaHei", sans-serif;
}

/* bad */
body {
    font-family: arial, sans-serif;
}

h1 {
    font-family: Arial, "Microsoft YaHei", sans-serif;
}

字号

[强制] 需要在 Windows 平台显示的中文内容,其字号应不小于 12px。

解释:由于 Windows 的字体渲染机制,小于 12px 的文字显示效果极差、难以辨认。

字体风格

[建议] 需要在 Windows 平台显示的中文内容,不要使用除 normal 外的 font-style。其他平台也应慎用。

  • 解释:由于中文字体没有 italic 风格的实现,所有浏览器下都会 fallback 到 obilique 实现 (自动拟合为斜体),小字号下 (特别是 Windows 下会在小字号下使用点阵字体的情况下) 显示效果差,造成阅读困难。

字重

[强制] font-weight 属性必须使用数值方式描述。

  • 解释:CSS 的字重分 100 – 900 共九档,但目前受字体本身质量和浏览器的限制,实际上支持 400 和 700 两档,分别等价于关键词normal 和 bold。 浏览器本身使用一系列启发式规则来进行匹配,在 <700 时一般匹配字体的 Regular 字重,>=700 时匹配 Bold 字重。

    但已有浏览器开始支持 =600 时匹配 Semibold 字重,故使用数值描述增加了灵活性,也更简短。

示例:

/* good */
h1 {
    font-weight: 700;
}

/* bad */
h1 {
    font-weight: bold;
}

行高

[建议] line-height 在定义文本段落时,应使用数值。 解释:将 line-height 设置为数值,浏览器会基于当前元素设置的 font-size 进行再次计算。在不同字号的文本段落组合中,能达到较为舒适的行间间隔效果,避免在每个设置了 font-size 都需要设置 line-height。 当 line-height 用于控制垂直居中时,还是应该设置成与容器高度一致。

示例:

.container {
    line-height: 1.5;
}

变换与动画

[强制] 使用 transition 时应指定 transition-property。

示例:

/* good */
.box {
    transition: color 1s, border-color 1s;
}

/* bad */
.box {
    transition: all 1s;
}

[建议] 尽可能在浏览器能高效实现的属性上添加过渡和动画。 解释:在可能的情况下应选择这样四种变换: - transform: translate(npx, npx); - transform: scale(n); - transform: rotate(ndeg); - opacity: 0.1; 典型的,可以使用 translate 来代替 left 作为动画属性。

示例:

/* good */
.box {
    transition: transform 1s;
}
.box:hover {
    transform: translate(20px); /* move right for 20px */
}

/* bad */
.box {
    left: 0;
    transition: left 1s;
}
.box:hover {
    left: 20px; /* move right for 20px */
}

响应式

[强制] Media Query 不得单独编排,必须与相关的规则一起定义。

示例:

/* Good */
/* header styles */
@media (...) {
    /* header styles */
}

/* main styles */
@media (...) {
    /* main styles */
}

/* footer styles */
@media (...) {
    /* footer styles */
}


/* Bad */
/* header styles */
/* main styles */
/* footer styles */

@media (...) {
    /* header styles */
    /* main styles */
    /* footer styles */
}

[强制] Media Query 如果有多个逗号分隔的条件时,应将每个条件放在单独一行中。

示例:

@media
(-webkit-min-device-pixel-ratio: 2), /* Webkit-based browsers */
(min--moz-device-pixel-ratio: 2),    /* Older Firefox browsers (prior to Firefox 16) */
(min-resolution: 2dppx),             /* The standard way */
(min-resolution: 192dpi) {           /* dppx fallback */
    /* Retina-specific stuff here */
}

[建议] 尽可能给出在高分辨率设备 (Retina) 下效果更佳的样式。

⬆️ 🏠返回顶部

兼容性

属性前缀

[强制] 带私有前缀的属性由长到短排列,按冒号位置对齐。

  • 解释:带私有属性
  • 标准属性放在最后,按冒号对齐方便阅读,也便于在编辑器内进行多行编辑。

示例:

.box {
    -webkit-box-sizing: border-box;
       -moz-box-sizing: border-box;
            box-sizing: border-box;
}

Hack

[建议] 需要添加 hack 时应尽可能考虑是否可以采用其他方式解决。

  • 解释:如果能通过合理的 HTML 结构或使用其他的 CSS 定义达到理想的样式,则不应该使用 hack 手段解决问题。通常 hack 会导致维护成本的增加。

[建议] 尽量使用 选择器 hack 处理兼容性,而非 属性 hack。

  • 解释:尽量使用符合 CSS 语法的 selector hack,可以避免一些第三方库无法识别 hack 语法的问题。

示例:

/* IE 7 */
*:first-child + html #header {
    margin-top: 3px;
    padding: 5px;
}

/* IE 6 */
* html #header {
    margin-top: 5px;
    padding: 4px;
}

[建议] 尽量使用简单的 属性 hack。

示例:

.box {
    _display: inline; /* fix double margin */
    float: left;
    margin-left: 20px;
}

.container {
    overflow: hidden;
    *zoom: 1; /* triggering hasLayout */
}

⬆️ 🏠返回顶部