目录
一、组件的基本示例
组件是可复用的 Vue 实例,且带有一个名字:在以下例子中是<my-cop>。
因为组件是可复用的 Vue 实例,所以它们与 new Vue
接收相同的配置选项,例如 data
、computed
、watch
、methods
以及生命周期钩子等。仅有的例外是像 el
这样根实例特有的选项。
// 全局定义一个名为 my-cop 的新组件-------------------
Vue.component('my-cop',{
template: `<div><h2>{{name}}</h2><div>{{total}}</div><button @click="add">点我加1</button></div>
`,
data(){
return {
name: 'lily',
count: 1
}
},
computed: {
total(){
return this.count*10
}
},
methods: {
add(){
this.count += 1
console.log('1111111111')
}
}
})
// Vue根实例----------------
new Vue({
el: '#app',
data(){
return {
currentComp: 'home'
}
}
})
我们可以在一个通过 new Vue
创建的 Vue 根实例中,把<my-cop>这个组件作为自定义元素来使用。
<div id="app">
<my-cop></my-cop>
</div>
二、组件的复用
组件可以进行任意次数的复用。
注意上面代码示例中,当点击按钮时,每个组件都会各自独立维护它的 count
。因为你每用一次组件,就会有一个它的新实例被创建。
组件中的data配置项必须是函数形式的,(根组件可以是对象式也可以是函数式),这样每次复用组件,都会生成一个新的实例,可以维护一份 独立的拷贝。如果 Vue 没有这条规则,对其中某一复用组件进行数据交互,所有的复用组件的数据都会同时影响。
<div id="app">
<my-cop></my-cop>
<my-cop></my-cop>
<my-cop></my-cop>
</div>
三、组件的组织结构
通常一个应用会以一棵嵌套的组件树的形式来组织。
例如:你可能会有页头、侧边栏、内容区等组件,每个组件又包含了其它的像导航链接、博文之类的组件。
四、组件注册
两种注册类型:全局注册和局部注册。
全局注册的组件可以用在其被注册之后的任何 (通过 new Vue
) 新创建的 Vue 根实例,也包括其组件树中的所有子组件的模板中。
1、组件名
(1)、定义
在注册一个组件的时候,我们始终需要给它一个名字。如下组件名就是 Vue.component
的第一个参数my-component-name。
组件名称建议语义化,根据组件的功能命名。当直接在 DOM 中使用一个组件 (而不是在字符串模板或单文件组件) 的时候,我们强烈推荐遵循 W3C 规范中的自定义组件名 (字母全小写且必须包含一个连字符)。这会帮助你避免和当前以及未来的 HTML 元素相冲突。
你可以在风格指南中查阅到关于组件名的其它建议。
Vue.component('my-component-name', { /* ... */ })
定义组件名的方式有两种:
(2)、使用 kebab-case
当使用 kebab-case (短横线分隔命名) 定义一个组件时,你也必须在引用这个自定义元素时使用 kebab-case,例如 <my-component-name>
。
Vue.component('my-component-name', { /* ... */ })
(3)、使用 PascalCase
当使用 PascalCase (首字母大写命名) 定义一个组件时,你在引用这个自定义元素时两种命名法都可以使用。也就是说 <my-component-name>
和 <MyComponentName>
都是可接受的。注意,尽管如此,直接在 DOM (即非字符串的模板) 中使用时只有 kebab-case 是有效的。
Vue.component('MyComponentName', { /* ... */ })
2、全局注册
全局注册需要用过 Vue.component
来创建组件。
Vue.component('my-component-name' , {
templete:``,data(){},
methods:{},
computed:{}
.
.
.
})
在注册之后可以用在任何新创建的 Vue 根实例 (new Vue
) 的模板中。
在所有子组件中也是如此,也就是说这三个组件在各自内部也都可以相互使用。
Vue.component('component-a', { /* ... */ })
Vue.component('component-b', { /* ... */ })
Vue.component('component-c', { /* ... */ })
new Vue({ el: '#app' })
// --------------------------------
<div id="app">
<component-a></component-a>
<component-b></component-b>
<component-c></component-c>
</div>
3、局部注册
全局注册往往是不够理想的。比如,如果你使用一个像 webpack 这样的构建系统,全局注册所有的组件意味着即便你已经不再使用一个组件了,它仍然会被包含在你最终的构建结果中。这造成了用户下载的 JavaScript 的无谓的增加。
局部注册使用方法:通过一个普通的 JavaScript 对象来定义组件
var ComponentA = { /* ... */ }
var ComponentB = { /* ... */ }
var ComponentC = { /* ... */ }
然后在 components
选项中定义你想要使用的组件。
对于 components
对象中的每个 property 来说,其 property 名就是自定义元素的名字,其 property 值就是这个组件的选项对象。
new Vue({ el: '#app', components: { 'component-a': ComponentA, 'component-b': ComponentB } })
注意:局部注册的组件在其子组件中不可用。例如,如果你希望 ComponentA
在 ComponentB
中可用,则你需要这样写。
var ComponentA = { /* ... */ }
var ComponentB = {
components: {
'component-a': ComponentA
},
// ...
}
或者如果你通过 Babel 和 webpack 使用 ES2015 模块,那么代码看起来更像:
// 在B组件中--------------------------------
//1、引入组件
import ComponentA from './ComponentA.vue'
//2、注册组件
export default {
components: {
ComponentA
},
// ...
}//3、使用组件
<component-a></component-a>
4、模块系统
(1)在模块系统中局部注册组件
使用了诸如 Babel 和 webpack 的模块系统的情况下,推荐创建一个 components
目录文件夹,并将每个组件放置在其各自的文件中。
然后需要在局部注册之前导入每个使用的组件。引入后局部注册,然后 ComponentA
和 ComponentC
都可以在 ComponentB
的模板中使用了。
// 组件B中代码
import ComponentA from './ComponentA'
import ComponentC from './ComponentC'
export default {
components: {
ComponentA,
ComponentC
},
// ...
}
(2)基础组件自动化全局注册
全局注册的行为必须在根 Vue 实例 (通过 new Vue
) 创建之前发生。
许多组件只是包裹了一个输入框或按钮之类的元素,是相对通用的。我们有时候会把它们称为基础组件,它们会在各个组件中被频繁的用到。
所以会导致很多组件里都会有一个包含基础组件的长列表,而只是用于模板中的一小部分:
import BaseButton from './BaseButton.vue'
import BaseIcon from './BaseIcon.vue'
import BaseInput from './BaseInput.vue'
export default {
components: {
BaseButton,
BaseIcon,
BaseInput
}
}
// -----------------------
<BaseInput
v-model="searchText"
@keydown.enter="search"
/>
<BaseButton @click="search">
<BaseIcon name="search"/>
</BaseButton>
如果你恰好使用了 webpack (或在内部使用了 webpack 的 Vue CLI 3+),那么就可以使用 require.context
只全局注册这些非常通用的基础组件。这里有一份可以让你在应用入口文件 (比如 src/main.js
) 中全局导入基础组件的示例代码:
import Vue from 'vue'
import upperFirst from 'lodash/upperFirst'
import camelCase from 'lodash/camelCase'
const requireComponent = require.context(
// 其组件目录的相对路径
'./components',
// 是否查询其子目录
false,
// 匹配基础组件文件名的正则表达式
/Base[A-Z]\w+\.(vue|js)$/
)
requireComponent.keys().forEach(fileName => {
// 获取组件配置
const componentConfig = requireComponent(fileName)
// 获取组件的 PascalCase 命名
const componentName = upperFirst(
camelCase(
// 获取和目录深度无关的文件名
fileName
.split('/')
.pop()
.replace(/\.\w+$/, '')
)
)
// 全局注册组件
Vue.component(
componentName,
// 如果这个组件选项是通过 `export default` 导出的,
// 那么就会优先使用 `.default`,
// 否则回退到使用模块的根。
componentConfig.default || componentConfig
)
})
五、组件的单个根实例
当构建一个组件时,组件模板必须只有一个根元素。可以用一个父元素,包裹所有元素。
否则Vue 会报错错误,并解释道 every component must have a single root element (每个组件必须只有一个根元素)
<div class="father-container">
<h3>{{ title }}</h3>
<div v-html="content"></div>
</div>
六、组件的props
1、props定义
通过props给子组件传递数据。
注意:prop 会在一个组件实例创建之前进行验证,所以实例的 property (如 data
、computed
等) 在 default
或 validator
函数中是不可用的。
在组件上注册的一些prop自定义属性,把一个值传递给一个 prop自定义属性的时候,它就变成了那个组件实例的一个属性。在子组件中,通过 props
配置选项,接受 prop 属性。
// 父组件中使用子组件,并增加自定义属性title
<blog-post title="My journey with Vue"></blog-post>
// 在子组件中接受prop属性title
Vue.component('blog-post', {
props: ['title'], // 接受父组件传来的title属性,在子组件中使用跟data中属性一样使用。
template: '<h3>{{ title }}</h3>'
})
2、传递多个prop属性的方法
当组件变得越来越复杂的时候,我们的子组件不只需要标题,还需要内容、发布日期、评论等等。为每个相关的信息定义一个 prop 会变得很麻烦。
<blog-post
v-for="post in posts"
v-bind:key="post.id"
v-bind:title="post.title"
v-bind:content="post.content"
v-bind:publishedAt="post.publishedAt"
v-bind:comments="post.comments"
></blog-post>
我们可以将需要传递的多个属性放在一个数组或者对象中一起传递。不论何时为 post
对象添加一个新的 property,它都会自动地在 <blog-post>
内可用,并同步更新。
// jiang post整体传递过去,整体接受post对象
<blog-post
v-for="post in posts"
v-bind:key="post.id"
v-bind:post="post"
></blog-post>
Vue.component('blog-post', {
props: ['post'],
template: `
<div class="blog-post">
<h3>{{ post.title }}</h3>
<div v-html="post.content"></div>
</div>
`
})
3、prop大小写
HTML 中的属性名是大小写不敏感的,所以浏览器会把所有大写字符解释为小写字符。这意味着当你使用 DOM 中的模板时,camelCase (驼峰命名法) 的 prop 名需要使用其等价的 kebab-case (短横线分隔命名) 命名。
Vue.component('blog-post', {
// 在 JavaScript 中是 camelCase 的
props: ['postTitle'],
template: '<h3>{{ postTitle }}</h3>'
})
// -------------------------------
<!-- 在 HTML 中是 kebab-case 的 -->
<blog-post post-title="hello!"></blog-post>
4、prop类型
(1)、字符串数组形式的 prop
props: ['title', 'likes', 'isPublished', 'commentIds', 'author']
(2)、对象形式的 prop
可以给每个 prop 都指定值的类型。对象中属性的名称和值分别是 prop 各自的名称和类型。
这不仅为组件提供了文档,还会在它们遇到错误的类型时,从浏览器的 JavaScript 控制台提示用户。
props: {
title: String,
likes: Number,
isPublished: Boolean,
commentIds: Array,
author: Object,
callback: Function,
contactsPromise: Promise // or any other constructor
}
5、传递静态和动态prop
(1)、静态prop
给 prop 传入一个静态的值:
<blog-post title="My journey with Vue"></blog-post>
(2)、动态prop
通过 v-bind
动态赋值传入 prop ,适用于一开始不清楚要渲染的具体内容,需要从接口获取数据时候,是非常有用的。
<!-- 动态赋予一个变量的值 -->
<blog-post v-bind:title="post.title"></blog-post>
<!-- 动态赋予一个复杂表达式的值 -->
<blog-post
v-bind:title="post.title + ' by ' + post.author.name"
></blog-post>
(3)、特殊类型的prop值
我们传入的值都是字符串类型的,但实际上任何类型的值都可以传给一个 prop。
传入一个数字:
<!-- 即便 `10` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue这是一个 JavaScript 表达式而不是一个字符串。 -->
<blog-post v-bind:likes="10"></blog-post>
<!-- 用一个变量进行动态赋值。post.likes=10-->
<blog-post v-bind:likes="post.likes"></blog-post>
传入一个布尔值:
<!-- 包含该 prop 没有值的情况在内,都意味着默认 `true`,is-published为true。-->
<blog-post is-published></blog-post>
<!-- 即便 `false` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue这是一个 JavaScript 表达式而不是一个字符串。 -->
<blog-post v-bind:is-published="false"></blog-post>
<!-- 用一个变量进行动态赋值,post.isPublished值为false。-->
<blog-post v-bind:is-published="post.isPublished"></blog-post>
传入一个数组:
<!-- 即便数组是静态的,我们仍然需要 `v-bind` 来告诉 Vue这是一个 JavaScript 表达式而不是一个字符串。 -->
<blog-post v-bind:comment-ids="[234, 266, 273]"></blog-post>
<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:comment-ids="post.commentIds"></blog-post>
传入一个对象:
<!-- 即便对象是静态的,我们仍然需要 `v-bind` 来告诉 Vue 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post
v-bind:author="{
name: 'Veronica',
company: 'Veridian Dynamics'
}"
></blog-post>
<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:author="post.author"></blog-post>
6、单向数据流
所有的 prop 都使得其父子 prop 之间形成了一个单向下行绑定:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。这样会防止从子组件意外变更父级组件的状态,从而导致你的应用的数据流向难以理解。
额外的,每次父级组件发生变更时,子组件中所有的 prop 都将会刷新为最新的值。这意味着你不应该在一个子组件内部改变 prop。如果你这样做了,Vue 会在浏览器的控制台中发出警告。
有两种常见的试图变更一个 prop 的情形:
(1)这个 prop 用来传递一个初始值;这个子组件接下来希望将其作为一个本地的 prop 数据来使用。在这种情况下,最好定义一个本地的 data 属性并将这个 prop 用作其初始值。
props: ['initialCounter'],
data: function () {
return {
counter: this.initialCounter
}
}
(2)这个 prop 以一种原始的值传入且需要进行转换。在这种情况下,最好使用这个 prop 的值来定义一个计算属性。
props: ['size'],
computed: {
normalizedSize: function () {
return this.size.trim().toLowerCase()
}
}
注意:在 JavaScript 中对象和数组是通过引用传入的,所以对于一个数组或对象类型的 prop 来说,在子组件中改变变更这个对象或数组本身,将会影响到父组件的状态。(子组件和父组件的这个对象或者数组指向的是同一个指针,当更改对应指针存储的值后,子组件和父组件的对象或者数组也会发生变化)
7、prop验证
可以给组件的 prop 指定验证要求,如果有一个需求没有被满足,则 Vue 会在浏览器控制台中警告你。这在开发一个会被别人用到的组件时尤其有帮助。
为了定制 prop 的验证方式,可以为 props
中的值提供一个带有验证需求的对象,而不是一个字符串数组。当 prop 验证失败的时候,(开发环境构建版本的) Vue 将会产生一个控制台的警告。
props: {
// 基础的类型检查 (`null` 和 `undefined` 会通过任何类型验证)
propA: Number,
// 多个可能的类型
propB: [String, Number],
// 类型为字符串,且必填
propC: {
type: String,
required: true
},
// 类型为数值,且有默认值100
propD: {
type: Number,
default: 100
},
// 带有默认值的对象
propE: {
type: Object,
// 对象或数组默认值必须从一个工厂函数获取
default: function () {
return { message: 'hello' }
}
},
// 自定义验证函数
propF: {
validator: function (value) {
// 这个值必须匹配下列字符串中的一个
return ['success', 'warning', 'danger'].includes(value)
}
}
}
})
可验证的类型有:
String
Number
Boolean
Array
Object
Date
Function
Symbol
type
还可以是一个自定义的构造函数,并且通过instanceof
来进行检查确认。例如,给定下列现成的构造函数:-
// 构造函数 function Person (firstName, lastName) { this.firstName = firstName this.lastName = lastName } // 验证 Vue.component('blog-post', { props: { author: Person } })
8、非prop属性
一个非 prop 的 attribute 是指传向一个组件,但是该组件并没有使用props配置项接收相应 prop 定义的 attribute。
因为显式定义的 prop 适用于向一个子组件传入信息,然而组件库的作者并不总能预见组件会被用于怎样的场景。这也是为什么组件可以接受任意的 attribute,而这些 attribute 会被添加到这个组件的根元素上。
<bootstrap-date-input data-date-picker="activated"></bootstrap-date-input
然后这个 data-date-picker="activated"
属性就会自动添加到 <bootstrap-date-input>
的根元素上。
9、替换和合并已有属性
对于绝大多数 attribute 来说,从外部提供给组件的值会替换掉组件内部设置好的值。所以如果传入 type="text"
就会替换掉 type="date"
并把它破坏!庆幸的是,class
和 style
attribute 会稍微智能一些,即两边的值会被合并起来,从而得到最终的值:form-control date-picker-theme-dark
。
// 子组件代码
<input type="date" class="form-control">
// 父组件代码
<bootstrap-date-input
data-date-picker="activated"
class="date-picker-theme-dark"
></bootstrap-date-input>
form-control
,这是在组件的模板内设置好的date-picker-theme-dark
,这是从组件的父级传入的
10、禁用属性继承
如果你不希望组件的根元素继承 attribute,你可以在组件的选项中设置 inheritAttrs: false
。
Vue.component('my-component', {
inheritAttrs: false,
// ...
})