css 规范

CSS 编码规范

虽然本文档是针对CSS设计的，但是在使用各种CSS的预编译器(如less、sass、stylus等)时，适用的部分也应尽量遵循本文档的约定。

命名规范

文件命名

在项目中统一将css抽离成单独文件，使用style.scss命名，并引入到界面中

├─xxxx    
│  ├─component.js    
│  └─index.vue 
│  └─style.scss            

其他样式文件使用小写字母，复合词以 - 分隔; 例如 menu.css , sub-menu.css

id 和类的命名

类名统一使用小驼峰命名： camel-case,推荐使用 BEM 格式命名。

BEM链接： https://juejin.cn/post/687636...

模块-名 __ 元素-名 -- 修饰器-名 -- 修饰器-值

block-name__elem-name--mod-name--mod-val

优势：

• 避免样式冲突
• 减小名称长度
• 提高可阅读性
• 增加样式重用

为id和类命名的时候要使用有意义或通用的名字（可参考末尾附录）。例如：

// 不推荐
#aaa {}
// 推荐
#login {}
// 通用
.clearfix {}

简写属性名字

为了提高可读性，尽可能的使用简写属性。例如:

/* 不推荐 */
padding-bottom: 2em;
padding-left: 1em;
padding-right: 1em;
padding-top: 0;

/* 推荐 */
padding: 0 1em 2em;

通用

拒绝在元素上直接写style

项目过去中有定义很多常用的工具类如： margin-t-1x等，请尽可能减少使用。
后期维护十分繁琐，容易出现叠加style情况。

/* 不推荐 */
 

 
 

 

选择器

如无必要，不得为 id、class 选择器添加类型选择器进行限定。在性能和维护性上，都有一定的影响。例如：

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

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

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

/* 推荐 */
#username input {}
.comment .avatar {}

/* 不推荐 */
.page .header .login #username input {}
.comment div * {}

!important

尽量不使用 !important 声明。

.vue文件引入style

建议配合使用scoped， 划定作用域，减少污染。
对于更改组件中的样式，推荐使用 穿透/deep/ 操作符，进行局部修改。

属性缩写

建议：在可以使用缩写的情况下，尽量使用属性缩写。例如：

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

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

建议：使用 border 、margin 、 padding 等缩写时，应注意隐含值对实际数值的影响，确实需要设置多个方向的值时才使用缩写。

属性书写顺序

建议：属性在书写时，应并以布局方式、位置 > 尺寸 > 文本相关 > 视觉效果 的顺序书写，以提高代码的可读性。

1. 位置属性(position, top, right, z-index, display, float等)
2. 尺寸(width, height, padding, margin)
3. 文本(font, line-height, letter-spacing, color- text-align等)
4. 视觉(background, border等)
5. 其他(animation, transition等)

另外，如果包含 content 属性，应放在最前面。

清除浮动

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

触发 BFC 的方式很多，常见的有：

• float 非 none
• position 非 static
• overflow 非 visible

另需注意，对已经触发 BFC 的元素不需要再进行 clearfix。

格式规范

空格

选择器与{}之间要包含空格。例如：

.menu {}

行长度

每行不得超过120个字符，除非单行不可分割。

空行

多个选择以及声明间以行分隔；例如：

/* 推荐 */
.h1,
.h2,
.h3 {
    line-height: 1.5;
}

/* 不推荐 */
.h1, .h2, .h3 {
    line-height: 1.5;
}

>、+、~ 选择器的两边各保留一个空格。例如：

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

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

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

/* 不推荐 */
main>nav {
    padding: 10px;
}
label+input {
    margin-left: 5px;
}
input:checked~button {
    background-color: #69C;
}

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

不建议使用单引号，不允许不使用引号。例如：

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

属性

属性定义要另起一行

例如：

/* 推荐 */
.selector {
    margin: 0;
    padding: 0;
}

/* 不推荐 */
.selector { margin: 0; padding: 0; }

属性定义后必须以分号结尾

例如：

/* 推荐 */
.selector {
    margin: 0;
}

/* 不推荐 */
.selector {
    margin: 0
}

值与单位

数值

当数值为 0 - 1 之间的小数时，省略整数部分的 0。例如：

/* 推荐 */
panel {
    opacity: .8
}

/* 不推荐 */
panel {
    opacity: 0.8
}

长度

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

例如：

/* 推荐 */
body {
    padding: 0 5px;
}

/* 不推荐 */
body {
    padding: 0px 5px;
}

颜色

RGB颜色值必须使用十六进制记号形式 #rrggbb。一般不使用 rgb()。 带有透明度的颜色信息可以使用 rgba()。使用 rgba() 时每个逗号后必须保留一个空格。例如：

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

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

颜色值可以缩写时，必须使用缩写形式。例如：

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

/* 不推荐 */
.success {
    background-color: #aaccaa;
}

颜色值不允许使用命名色值。例如：

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

/* 不推荐 */
.success {
    color: lightgreen;
}

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

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

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

/* 不推荐 */
.success {
    background-color: #ACA;
    color: #90ee90;
}

2D 位置

必须同时给出水平和垂直方向的位置。2D 位置初始值为 0% 0%，但在只有一个方向的值时，另一个方向的值会被解析为 center。为避免理解上的困扰，应同时给出两个方向的值。例如：

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

/* 不推荐 */
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";
}

字号

需要在 Windows 平台显示的中文内容，其字号应不小于 12px。由于 Windows 的字体渲染机制，小于 12px 的文字显示效果极差、难以辨认。

字体风格

需要在 Windows 平台显示的中文内容，不要使用除 normal 外的 font-style。其他平台也应慎用。由于中文字体没有 italic 风格的实现，所有浏览器下都会 fallback 到 obilique 实现 (自动拟合为斜体)，小字号下 (特别是 Windows 下会在小字号下使用点阵字体的情况下) 显示效果差，造成阅读困难。

字重

font-weight 属性必须使用数值方式描述。CSS 的字重分 100 – 900 共九档，但目前受字体本身质量和浏览器的限制，实际上支持 400 和 700 两档，分别等价于关键词 normal 和 bold。例如：

/* 推荐 */
h1 {
    font-weight: 700;
}

/* 不推荐 */
h1 {
    font-weight: bold;
}

行高

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

.container {
    line-height: 1.5;
}

变换与动画

使用 transition 时应指定 transition-property。例如：

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

/* 不推荐 */
.box {
    transition: all 1s;
}

尽可能在浏览器能高效实现的属性上添加过渡和动画。在可能的情况下应选择这样四种变换：

• transform: translate(npx, npx);
• transform: scale(n);
• transform: rotate(ndeg);
• opacity: 0..1;

典型的，可以使用 translate 来代替 left 作为动画属性。例如：

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

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

响应式

Media Query 不得单独编排，必须与相关的规则一起定义。例如：

/* 推荐 */
/* header styles */
@media (...) {
    /* header styles */
}

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

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


/* 不推荐 */
/* 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 */
}