16.完整单词的组件名称
组件名称应该倾向于完整单词而不是缩写。
举例:
反例
components/
|- SdSettings.vue
|- UProfOpts.vue
// 正确写法
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
17.Prop 名称
在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case。
举例
反例
props: {
'greeting-text': String
}
//模版中
<WelcomeMessage greetingText="hi"/>
// 正确
props: {
greetingText: String
}
// 模版中
<WelcomeMessage greeting-text="hi"/>
18.多个 attribute
的元素
多个 attribute
的元素应该分多行撰写,每个 attribute
一行。
举例
// 反例
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
// 正确
<img
src="https://vuejs.org/images/logo.png"
alt="Vue Logo"
>
<MyComponent
foo="a"
bar="b"
baz="c"
/>
19.模板中的简单表达式
组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。
// 反例
{{
fullName.split(' ').map((word) => {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}}
// 正确
<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {
normalizedFullName() {
return this.fullName.split(' ')
.map(word => word[0].toUpperCase() + word.slice(1))
.join(' ')
}
}
20.简单的计算属性
应该把复杂计算属性分割为尽可能多的更简单的 property。即 单个计算属性只有单一功能。
// 反例
computed: {
price() {
const basePrice = this.manufactureCost / (1 - this.profitMargin)
return (
basePrice -
basePrice * (this.discountPercent || 0)
)
}
}
computed: {
basePrice() {
return this.manufactureCost / (1 - this.profitMargin)
},
discount() {
return this.basePrice * (this.discountPercent || 0)
},
finalPrice() {
return this.basePrice - this.discount
}
}
21.带引号的 attribute
值
非空 HTML attribute 值应该始终带引号 (单引号或双引号,选你 JS 里不用的那个)。
在 HTML 中不带空格的 attribute 值是可以没有引号的,但这鼓励了大家在特征值里不写空格,导致可读性变差。
举例:
// 反例
<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
// 正确
<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">
22.指令缩写
指令缩写 (用 : 表示 v-bind
:,@
表示 v-on
: 和用 #
表示 v-slot
) 应该要么都用要么都不用。
举例
// 反例
<input
v-bind:value="newTodoText"
:placeholder="newTodoInstructions"
>
<input
v-on:input="onInput"
@focus="onFocus"
>
// 不统一风格
<template v-slot:header>
<h1>Here might be a page title</h1>
</template>
<template #footer>
<p>Here's some contact info</p>
</template>
// 正确
<input
:value="newTodoText"
:placeholder="newTodoInstructions"
>
<input
v-bind:value="newTodoText"
v-bind:placeholder="newTodoInstructions"
>
<input
@input="onInput"
@focus="onFocus"
>
<input
v-on:input="onInput"
v-on:focus="onFocus"
>
// 统一风格
<template v-slot:header>
<h1>Here might be a page title</h1>
</template>
<template v-slot:footer>
<p>Here's some contact info</p>
</template>
<template #header>
<h1>Here might be a page title</h1>
</template>
<template #footer>
<p>Here's some contact info</p>
</template>
三,推荐使用
23.组件/实例的选项顺序
这是我们推荐的组件选项默认顺序。它们被划分为几大类,所以你也能知道从插件里添加的新 property 应该放到哪里。属性出现的顺序 如下
-
name
组件以外的知识。 -
components
,directives
模版依赖(模版内使用的资源) -
extends
,mixins
,provide/inject
。组合 (向选项里合并 property) -
inheritAttrs
,props
,emits
。接口(组件的接口) -
setup
.组合式 API (使用组合式 API 的入口点) -
data
,computed
。 local State (原生响应式 property) -
watch
事件 (通过响应式事件触发的回调)。beforeCreate
,created
,beforeMount
,mounted
,beforeUpdate
,updated
,activated
,deactivated
,beforeUnmount
,unmounted
,errorCaptured
,renderTracked
,renderTriggered
。生命周期钩子 (按照它们被调用的顺序) -
methods
非响应式的 property (不依赖响应性系统的实例 property) -
template/render
渲染 (组件输出的声明式描述)
24.元素 attribute 的顺序
元素 (包括组件) 的 attribute 应该有统一的顺序。
-
定义 (提供组件的选项)
is
-
列表渲染
v-for
-
条件渲染 (元素是否渲染/显示)
v-if
v-else-if
v-else
v-show
v-cloak
-
渲染修饰符 (改变元素的渲染方式)
v-pre
v-once
-
全局感知 (需要超越组件的知识)
id
-
唯一的 Attributes (需要唯一值的 attribute)
ref
key
-
双向绑定 (把绑定和事件结合起来)
v-model
8.其他 Attributes (所有普通的绑定或未绑定的 attribute)
- 事件 (组件事件监听器)
v-on
- 内容 (覆写元素的内容)
v-html
v-text
24. 组件/实例选项中的空行
你可能想在多个 property 之间增加一个空行,特别是在这些选项一屏放不下,需要滚动才能都看到的时候。
举例:
// 反例
props: {
value: {
type: String,
required: true
},
focused: {
type: Boolean,
default: false
},
label: String,
icon: String
},
computed: {
formattedValue() {
// ...
},
inputClasses() {
// ...
}
}
// 推荐
props: {
value: {
type: String,
required: true
},
focused: {
type: Boolean,
default: false
},
label: String,
icon: String
},
computed: {
formattedValue() {
// ...
},
inputClasses() {
// ...
}
}
25. 单文件组件的顶级元素的顺序
单文件组件应该总是让 <script>、<template>
和 <style>
标签的顺序保持一致。且 <style>
要放在最后,因为另外两个标签至少要有一个。
举例:
// 反例
<style>/* ... */</style>
<script>/* ... */</script>
<template>...</template>
<!-- ComponentA.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style>
<!-- ComponentB.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>
// 推荐
<!-- ComponentA.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style>
<!-- ComponentB.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style>
或者
<!-- ComponentA.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>
<!-- ComponentB.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>
四,谨慎使用
26. scoped
中的元素选择器
元素选择器应该避免在 scoped 中出现。
在 scoped 样式中,类选择器比元素选择器更好,因为大量使用元素选择器是很慢的。
举例
// 反例
<template>
<button>×</button>
</template>
<style scoped>
button {
background-color: red;
}
</style>
// 推荐
<template>
<button class="btn btn-close">×</button>
</template>
<style scoped>
.btn-close {
background-color: red;
}
</style>
27. 隐性的父子组件通信
应该优先通过 prop
和事件进行父子组件之间的通信,而不是 this.$parent
或变更 prop
。
一个理想的 Vue
应用是 prop
向下传递,事件向上传递的。遵循这一约定会让你的组件更易于理解。然而,在一些边界情况下 prop
的变更或 this.$parent
能够简化两个深度耦合的组件。
问题在于,这种做法在很多简单的场景下可能会更方便。但请当心,不要为了一时方便 (少写代码) 而牺牲数据流向的简洁性 (易于理解)。
举例
// 反例
app.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: '<input v-model="todo.text">'
})
app.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
methods: {
removeTodo() {
this.$parent.todos = this.$parent.todos.filter(todo => todo.id !== vm.todo.id)
}
},
template: `
<span>
{{ todo.text }}
<button @click="removeTodo">
×
</button>
</span>
`
})
app.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: `
<input
:value="todo.text"
@input="$emit('input', $event.target.value)"
>
`
})
app.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: `
<span>
{{ todo.text }}
<button @click="$emit('delete')">
×
</button>
</span>
`
})
27. 非 Flux
的全局状态管理
应该优先通过 Vuex
管理全局状态,而不是通过 this.$root
或一个全局事件总线。