前端:Vue前端开发规范,值得收藏!
一、强制
1. 组件名为多个单词
组件名应该始终是多个单词的,根组件 App 除外。
正例:
export default {name: 'TodoItem',// ...
}
复制代码
反例:
export default {name: 'Todo',// ...
}
复制代码
2. 组件数据
组件的 data 必须是一个函数。
当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方),它的值必须是返回一个对象的函数。
正例:
// In a .vue file
export default {data () {return {foo: 'bar'}}
}
// 在一个 Vue 的根实例上直接使用对象是可以的,
// 因为只存在一个这样的实例。
new Vue({data: {foo: 'bar'}
})
复制代码
反例:
export default {data: {foo: 'bar'}
}
复制代码
3. Prop定义
Prop 定义应该尽量详细。
在你提交的代码中,prop 的定义应该尽量详细,至少需要指定其类型。
正例:
props: {status: String
}
// 更好的做法!
props: {status: {type: String,required: true,validator: function (value) {return ['syncing','synced','version-conflict','error'].indexOf(value) !== -1}}
}
复制代码
反例:
// 这样做只有开发原型系统时可以接受
props: ['status']
复制代码
4. 为v-for设置键值
总是用 key 配合 v-for。
在组件上_总是_必须用 key 配合 v-for,以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为,比如动画中的对象固化 (object constancy),也是一种好的做法。
正例:
<ul><liv-for="todo in todos":key="todo.id">{{ todo.text }}</li>
</ul>
复制代码
反例:
<ul><li v-for="todo in todos">{{ todo.text }}</li>
</ul>
复制代码
5.避免 v-if 和 v-for 用在一起
永远不要把 v-if 和 v-for 同时用在同一个元素上。
一般我们在两种常见的情况下会倾向于这样做:
为了过滤一个列表中的项目 (比如 v-for="user in users" v-if="user.isActive")。在这种情形下,请将 users 替换为一个计算属性 (比如 activeUsers),让其返回过滤后的列表。
为了避免渲染本应该被隐藏的列表 (比如 v-for="user in users" v-if="shouldShowUsers")。这种情形下,请将 v-if 移动至容器元素上 (比如 ul, ol)。
正例:
<ul v-if="shouldShowUsers"><liv-for="user in users":key="user.id">{{ user.name }}</li>
</ul>
复制代码
反例:
<ul><liv-for="user in users"v-if="shouldShowUsers":key="user.id">{{ user.name }}</li>
</ul>
复制代码
6. 为组件样式设置作用域
对于应用来说,顶级 App 组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。
这条规则只和单文件组件有关。你不一定要使用 scoped 特性。设置作用域也可以通过 CSS Modules,那是一个基于 class 的类似 BEM 的策略,当然你也可以使用其它的库或约定。
不管怎样,对于组件库,我们应该更倾向于选用基于 class 的策略而不是 scoped 特性。
这让覆写内部样式更容易:使用了常人可理解的 class 名称且没有太高的选择器优先级,而且不太会导致冲突。
正例:
<template><button class="c-Button c-Button--close">X</button>
</template>
<!-- 使用 BEM 约定 -->
<style>
.c-Button {border: none;border-radius: 2px;
}
.c-Button--close {background-color: red;
}
</style>
复制代码
反例:
<template><button class="btn btn-close">X</button>
</template>
<style>
.btn-close {background-color: red;
}
</style>
<template><button class="button button-close">X</button>
</template>
<!-- 使用 `scoped` 特性 -->
<style scoped>
.button {border: none;border-radius: 2px;
}
.button-close {background-color: red;
}
</style>
复制代码
二、强烈推荐(增强可读性)
1. 组件文件
只要有能够拼接文件的构建系统,就把每个组件单独分成文件。
当你需要编辑一个组件或查阅一个组件的用法时,可以更快速的找到它。
正例:
components/
|- TodoList.vue
|- TodoItem.vue
复制代码
反例:
Vue.component('TodoList', {// ...
})
Vue.component('TodoItem', {// ...
})
复制代码
2. 单文件组件文件的大小写
单文件组件的文件名应该要么始终是单词大写开头 (PascalCase)
正例:
components/
|- MyComponent.vue
复制代码
反例:
components/
|- myComponent.vue
|- mycomponent.vue
复制代码
3. 基础组件名
应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头,比如 Base、App 或 V。
正例:
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
复制代码
反例:
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
复制代码
4. 单例组件名
只应该拥有单个活跃实例的组件应该以 The 前缀命名,以示其唯一性。
这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何 prop,因为它们是为你的应用定制的,而不是它们在你的应用中的上下文。如果你发现有必要添加 prop,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。
正例:
components/
|- TheHeading.vue
|- TheSidebar.vue
复制代码
反例:
components/
|- Heading.vue
|- MySidebar.vue
复制代码
5. 紧密耦合的组件名
和父组件紧密耦合的子组件应该以父组件名作为前缀命名。
如果一个组件只在某个父组件的场景下有意义,这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。
正例:
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue
复制代码
反例:
components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue
复制代码
6. 组件名中的单词顺序
组件名应该以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。
正例:
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue
复制代码
反例:
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue
复制代码
7. 模板中的组件名大小写
总是 PascalCase 的
正例:
<!-- 在单文件组件和字符串模板中 -->
<MyComponent/>
复制代码
反例:
<!-- 在单文件组件和字符串模板中 -->
<mycomponent/>
<!-- 在单文件组件和字符串模板中 -->
<myComponent/>
复制代码
8. 完整单词的组件名
组件名应该倾向于完整单词而不是缩写。
正例:
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
复制代码
反例:
components/
|- SdSettings.vue
|- UProfOpts.vue
复制代码
9. 多个特性的元素
多个特性的元素应该分多行撰写,每个特性一行。
正例:
<imgsrc="https://vuejs.org/images/logo.png"alt="Vue Logo"
>
<MyComponentfoo="a"bar="b"baz="c"
/>
复制代码
反例:
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
复制代码
10. 模板中简单的表达式
组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。
复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么,而非如何计算那个值。而且计算属性和方法使得代码可以重用。
正例:
<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {normalizedFullName: function () {return this.fullName.split(' ').map(function (word) {return word[0].toUpperCase() + word.slice(1)}).join(' ')}
}
复制代码
反例:
{{fullName.split(' ').map(function (word) {return word[0].toUpperCase() + word.slice(1)}).join(' ')
}}
复制代码
11. 简单的计算属性
正例:
computed: {basePrice: function () {return this.manufactureCost / (1 - this.profitMargin)},discount: function () {return this.basePrice * (this.discountPercent || 0)},finalPrice: function () {return this.basePrice - this.discount}
}
复制代码
反例:
computed: {price: function () {var basePrice = this.manufactureCost / (1 - this.profitMargin)return (basePrice -basePrice * (this.discountPercent || 0))}
}
复制代码
12. 带引号的特性值
非空 HTML 特性值应该始终带引号 (单引号或双引号,选你 JS 里不用的那个)。
在 HTML 中不带空格的特性值是可以没有引号的,但这样做常常导致带空格的特征值被回避,导致其可读性变差。
正例:
<AppSidebar :style="{ width: sidebarWidth + 'px' }">
复制代码
反例:
<AppSidebar :style={width:sidebarWidth+'px'}>
复制代码
13. 指令缩写
都用指令缩写 (用 : 表示 v-bind: 和用 @ 表示 v-on:)
正例:
<input@input="onInput"@focus="onFocus"
>
复制代码
反例:
<inputv-bind:value="newTodoText":placeholder="newTodoInstructions"
>
复制代码
三、推荐
1. 单文件组件的顶级元素的顺序
单文件组件应该总是让<script>、<template> 和 <style> 标签的顺序保持一致。且 <style> 要放在最后,因为另外两个标签至少要有一个。
正例:
<!-- ComponentA.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>
复制代码
四、谨慎使用 (有潜在危险的模式)
1. 没有在 v-if/v-if-else/v-else 中使用 key
如果一组 v-if + v-else 的元素类型相同,最好使用 key (比如两个 <div> 元素)。
正例:
<divv-if="error"key="search-status"
>错误:{{ error }}
</div>
<divv-elsekey="search-results"
>{{ results }}
</div>
复制代码
反例:
<div v-if="error">错误:{{ error }}
</div>
<div v-else>{{ results }}
</div>
复制代码
2. scoped 中的元素选择器
元素选择器应该避免在 scoped 中出现。
在 scoped 样式中,类选择器比元素选择器更好,因为大量使用元素选择器是很慢的。
正例:
<template><button class="btn btn-close">X</button>
</template>
<style scoped>
.btn-close {background-color: red;
}
</style>
复制代码
反例:
<template><button>X</button>
</template>
<style scoped>
button {background-color: red;
}
</style>
复制代码
3. 隐性的父子组件通信
应该优先通过 prop 和事件进行父子组件之间的通信,而不是 this.$parent 或改变 prop。
正例:
Vue.component('TodoItem', {props: {todo: {type: Object,required: true}},template: `<input:value="todo.text"@input="$emit('input', $event.target.value)">`
})
复制代码
反例:
Vue.component('TodoItem', {props: {todo: {type: Object,required: true}},methods: {removeTodo () {var vm = thisvm.$parent.todos = vm.$parent.todos.filter(function (todo) {return todo.id !== vm.todo.id})}},template: `<span>{{ todo.text }}<button @click="removeTodo">X</button></span>`
})
复制代码
4. 非 Flux 的全局状态管理
应该优先通过 Vuex 管理全局状态,而不是通过 this.$root 或一个全局事件总线。
正例:
// store/modules/todos.js
export default {state: {list: []},mutations: {REMOVE_TODO (state, todoId) {state.list = state.list.filter(todo => todo.id !== todoId)}},actions: {removeTodo ({ commit, state }, todo) {commit('REMOVE_TODO', todo.id)}}
}
<!-- TodoItem.vue -->
<template><span>{{ todo.text }}<button @click="removeTodo(todo)">X</button></span>
</template>
<script>
import { mapActions } from 'vuex'
export default {props: {todo: {type: Object,required: true}},methods: mapActions(['removeTodo'])
}
</script>
复制代码
反例:
// main.js
new Vue({data: {todos: []},created: function () {this.$on('remove-todo', this.removeTodo)},methods: {removeTodo: function (todo) {var todoIdToRemove = todo.idthis.todos = this.todos.filter(function (todo) {return todo.id !== todoIdToRemove})}}
})
复制代码
附录
1. 推荐使用vs code进行前端编码,规定Tab大小为2个空格
vs code配置
{"editor.tabSize": 2,"workbench.startupEditor": "newUntitledFile","workbench.iconTheme": "vscode-icons",// 以下为stylus配置"stylusSupremacy.insertColons": false, // 是否插入冒号"stylusSupremacy.insertSemicolons": false, // 是否插入分好"stylusSupremacy.insertBraces": false, // 是否插入大括号"stylusSupremacy.insertNewLineAroundImports": false, // import之后是否换行"stylusSupremacy.insertNewLineAroundBlocks": false, // 两个选择器中是否换行"vetur.format.defaultFormatter.html": "js-beautify-html","eslint.autoFixOnSave": true,"eslint.validate": ["javascript",{"language": "html","autoFix": true},{"language": "vue","autoFix": true},"javascriptreact","html","vue"],"eslint.options": { "plugins": ["html"] },"prettier.singleQuote": true,"prettier.semi": false,"javascript.format.insertSpaceBeforeFunctionParenthesis": false,"vetur.format.js.InsertSpaceBeforeFunctionParenthesis": false,"vetur.format.defaultFormatter.js": "prettier",// "prettier.eslintIntegration": true
}
复制代码
vs code 插件
Auto Close Tag
Path Intellisense
Prettier
Vetur
vscode-icons
前端:Vue前端开发规范,值得收藏!相关推荐
- h5 默认为移动端页面_20条移动前端H5页面开发规范,h5开发必看文档
这是根据腾讯最新公布的<移动页面用户行为报告>来给大家分享的关于移动端H5页面开发一些20条规范和准则.里面大概包含了16种用户操作习惯和注意点. 下面25学堂跟大家先分享一张关于2016 ...
- 大前端–Vue前端体系、前后端分离
大前端–Vue前端体系.前后端分离 前言 Soc:关注点分离原则 HTML+CSS+JS(视图):给用户看,刷新后台给的数据 网络通信:axios 页面跳转:vue-router 状态管理:vuex ...
- 开发编程值得收藏的经典书籍 免费下载
开发编程值得收藏的经典书籍 免费下载 <疯狂的程序员>(绝影) 免费下载 http://www.izixue.com/thread-357-1-1.html?fromuid=30 &l ...
- 一步步教你前端vue项目开发中如何解决跨域问题
文章目录 开发环境中跨域 名词解释 1.同源策略: 2.同源: 3.跨域: 4.代理服务器: 解决方式 项目背景 跨域配置 1.配置说明: A.参数proxy详解: B.pathRewrite详解: ...
- 前端: 42 种前端常用布局方案,值得收藏!
对 CSS 布局掌握程度决定你在Web开发中的开发页面速度.随着Web技术的不断革新,实现各种布局的方式已经多得数不胜数了. 本篇文章总结了四十二种CSS的常见布局,这四十二种布局可以细分为如下几类: ...
- Web前端知识体系梳理,值得收藏!
前言 现在是信息时代,经过 web1.0 时期.web2.0 时期到现在的移动互联网时期,信息获取越来越高效,坐着不动就会有大量的新闻.博客.资讯向你推荐而来. 作为一名靠谱的程序员,你免不了要查阅大 ...
- 前端优化一些知识,值得收藏
2019独角兽企业重金招聘Python工程师标准>>> 1. viewport <meta name="viewport" content="wi ...
- thinkphp开发的小程序、公众号H5、浏览器端H5、前端vue框架开发
需要程序代码的可以找我提供 用户端包含:小程序.公众号H5.浏览器端H5 序号 功能模块 简介 1 商品 商品分类 支持两级分类,分类可添加分类图标,可设置排序和是否显示,支持分类搜索. 2 商品管理 ...
- 前端vue项目开发流程
产品给出需求文档,产品原型 阅读文档,梳理需求 评审需求(产品逻辑.交互是否合理) UI出图,交互设计稿 开始做详细设计(拆分需求模块,技术选型,调研技术方案中的不确定(用什么语言,什么框架等,dem ...
- Vue前端开发规范及代码风格
Vue.js 开发规范目录及说明 版本 v1.0 日期 2020-02-18 本文档为前端 vue 开发规范 规范目的 命名规范 结构化规范 注释规范 编码规范 CSS 规范 规范目的 为提高团队协作 ...
最新文章
- mysql主备数据库配置_MySQL双主互备配置
- 【数字信号处理】线性常系数差分方程 ( “ 线性常系数差分方程 “ 与 “ 线性时不变系统 “ 关联 | 根据 “ 线性常系数差分方程 “ 与 “ 边界条件 “ 确定系统是否是 线性时不变系统方法 )
- HTML之CSS画三角形原理,纯CSS写三角形样式集合(原理解析)
- ERROR: Command errored out with exit status 1一例
- ssl提高组周三备考赛【2018.10.17】
- 算法题复习(栈与队列、二叉树)
- java删除指定目录下文件_Java中循环删除指定目录下的文件
- 马斯克宣布退出OpenAI,全身心投入特斯拉与SpaceX
- 拓端tecdat|WINBUGS对随机波动率模型进行贝叶斯估计与比较
- 三分钟上手openldap帐号系统
- c语言写俄罗斯方块(源码)
- 行政区划代码(道路要素)
- 新手坐高铁怎么找车厢_坐高铁时如何快速找到自己车票上的车厢和座位! 说出来你都不敢相信...
- python读取txt文档乱码解决
- t480s控制面板打开触摸板_今年买的thinkpad T480S,但是使用感觉还不如5年前买的S3 touch速度快,是什么原因?...
- Mybatis小知识_typeAliases/typeAliases标签作用
- 物联网目前的应用场景有哪些
- lubuntu-调整分辨率
- 考研小助手 Mathematica 麦酱教你算不定积分 wolfram alpha
- code representation-CPG