显示目录

Vue 自定义组件

Vue 提供了自定义组件的功能,可以定义全局组件,也可以定义局部组件:

  • 全局组件: 使用 Vue.component() 来注册
  • 局部组件: 使用 Vue 对象的 components 属性来注册

下面先介绍全局组件的自定义,然后再简要的介绍局部组件的自定义。

最简单的组件

定义:

1
2
3
Vue.component('com-name', {
template: '<span>你好</span>'
});

使用:

1
<com-name></com-name>

组件的自定义和使用都非常简单,下面请看完整的可执行代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<!DOCTYPE html>
<html>

<head>
<meta charset="utf-8">
<script src="http://cdn.staticfile.org/vue/2.0.3/vue.js"></script>
</head>

<body>
<div id="app-one">
<com-name></com-name>
</div>

<div id="app-two">
<com-name></com-name>
</div>

<script>
// 自定义全局组件
// com-name 为组件的名字
// template 为组件的模版
Vue.component('com-name', {
template: '<span>你好</span>'
});

new Vue({
el: '#app-one',
data: {}
});
new Vue({
el: '#app-two',
data: {}
});
</script>
</body>

</html>

输出:

1
2
3
4
5
6
<div id="app-one">
<span>你好</span>
</div>
<div id="app-two">
<span>你好</span>
</div>

注: 下面为了描述简单,定义术语 parent 和 children:

  • app-oneapp-two 称为 parent
  • app-oneapp-two 调用的自定义组件 com-name 称为它们的 child

传递数据给组件

Parent 使用 props 给 children 组件传递数据:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<body>
<div id="app-one">
<x-button :text="'No'"></x-button> <!-- 直接使用字符串 -->
<x-button :text="buttonText"></x-button> <!-- 绑定 data -->
</div>

<script>
Vue.component('x-button', {
props: ['text'],
template: '<button>{{text}}</button>'
});

new Vue({
el: '#app-one',
data: {
buttonText: '按钮'
}
});
</script>
</body>

buttonText 的值改变后使用它的 x-button 的属性 text 的值也会变化。

组件中的 props 除了使用字符串数组外,还可以使用对象的方式:

1
2
3
4
5
props: {
html: String,
attachments: Array,
closable: { type: Boolean, default: false } // 默认为不可关闭
}

访问兄弟组件的数据

在父组件中给兄弟组件定义一个 ref,子组件可以通过父组件的 ref 访问兄弟组件的数据:

1
2
3
4
5
6
7
<template>
<Com1 ref="com1" />
<Com2 />
</template>

// 在 Com2 的函数中可以使用 ref 访问 Com1 的数据:
this.$parent.$refs.com1.count

使用 SLOT

上面使用 props 来给组件 x-button 传递按钮的文本,能不能这么 <x-button>按钮</x-button> 更直观的创建按钮呢?可以,使用 SLOT 就可以了:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<body>
<div id="app-one">
<x-button>按钮</x-button>
</div>

<script>
Vue.component('x-button', {
template: '<button><slot></slot></button>'
});

new Vue({
el: '#app-one'
});
</script>
</body>

输出:

1
<button>按钮</button>

能不能使用多个 SLOT 呢?可以,有多个 SLOT 时,需要给每个 SLOT 一个名字:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<body>
<div id="app-one">
<x-button>
<span slot="first">前缀</span>
<span slot="second">后缀</span>
</x-button>
</div>

<script>
Vue.component('x-button', {
template: '<button><slot name="first"></slot> -按钮- <slot name="second"></slot></button>'
});

new Vue({
el: '#app-one',
data: {
buttonText: '按钮'
}
});
</script>
</body>

输出:

1
<button><span>前缀</span> -按钮- <span>后缀</span></button>

组件发射信号

Parent 使用 propsslot 给 children 组件传递数据,children 使用 emit 把数据响应给 parent:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<body>
<div id="app-one">
<x-button @increased="valueChanged"></x-button> - {{value}}
</div>

<script>
// 点击按钮 count 加 1,让后发射信号,参数为当前的 count 值
// parent 监听到 increased 信号,然后调用 valueChanged 函数
Vue.component('x-button', {
template: '<button @click="increase">Count - {{count}}</button>',
data: function() {
return {
count: 0
};
},
methods: {
increase: function() {
this.count += 1;
this.$emit('increased', this.count); // 发射 increased 信号,参数为 count
}
}
});

new Vue({
el: '#app-one',
data: {
value: 0
},
methods: {
valueChanged: function(c) {
this.value = c;
}
}
});
</script>
</body>

注意:

  • 组件的 data 必须是一个函数,返回一个 JSON 对象
  • 组件发射信号使用 this.$emit 把数据传给 parent
  • 信号的名字不能使用驼峰规则命名,例如 valueChanged 是无效的
  • 信号名字的单词间可以用 - 分割,例如 value-changed 是合法的

父组件使用 ref 访问子组件的属性

在 parent 中给 child 定义一个 ref 属性,然后在 parent 你就可以通过 ref 直接访问 child 中 data 和 computed 定义的属性了:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<body>
<div id="app-one">
<x-button ref="button"></x-button> - {{value}} <!-- [1] 这里 -->
<Button @click="refChild">Button</Button>
</div>

<script>
// 点击按钮 count 加 1,让后发射信号,参数为当前的 count 值
// parent 监听到 increased 信号,然后调用 valueChanged 函数
Vue.component('x-button', {
template: '<button @click="increase">Count - {{count}}</button>',
data: function() {
return {
count: 0
};
},
methods: {
increase: function() {
this.count += 1;
}
}
});

new Vue({
el: '#app-one',
data: {
value: 0
},
methods: {
refChild: function(c) {
console.log(this.$refs['button'].count); // <!-- [2] 这里 -->
}
}
});
</script>
</body>

Bus 进行组件间通讯

组件之间通讯还可以使用 Bus,其实 Bus 就是一个 Vue 的对象 (var Bus = new Vue()),使用 emit 发射信号和使用 on 注册信号回调函数,典型的观察者模式应用:

  1. Bus.$emit('foo', 123)
  2. Bus.$on('foo', (p) => {});

当 Bus 调用 emit 发射信号的时候,此 Bus 对象使用 on 绑定响应此信号的回调函数会被自动调用,可以参考 https://www.cnblogs.com/fanlinqiang/p/7756566.html

为了方便,可以把 Bus 对象注入到根 Vue 对象中,然后使用 this.$Bus 进行访问:

1
2
3
4
5
6
7
// [1] 注入
const Bus = new Vue();
Vue.prototype.$Bus = Bus;

// [2] 使用
this.$Bus.$emit('foo', 123);
this.$Bus.$on('foo', (p) => {});

简化 template 模版

上面自定义组件的 template 是通过拼接字符串来实现的,如果这个字符串很长时就不好拼接了,可以把其放在 HTML 中的 template 元素里,通过 id 来引用,其他的 props, data, methods 等还是和以前的一样用法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<body>
<div id="app-one">
<x-button :text="'按钮'"></x-button> <!-- 绑定 data -->
</div>

<!-- 组件的 template 部分 -->
<template id="x-button-template">
<button @click="click">按钮</button>
</template>

<script>
Vue.component('x-button', {
template: '#x-button-template',
methods: {
click: function() {
console.log(new Date().getTime());
}
}
})

new Vue({
el: '#app-one',
data: {}
});
</script>
</body>

模版的标签名不一定要是 template,也可以是例如 <script type="html/text">template content</script>,只要是在网页中不可见的就好。

自定义局部组件

使用 Vue 对象的 components 属性来注册局部组件,下面定义的局部组件 x-button 只能在 app-one 中使用,不能在 app-two 使用:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<body>
<div id="app-one">
<x-button :text="buttonText"></x-button>
</div>
<div id="app-two">
<x-button :text="buttonText"></x-button> <!-- x-button 是在 app-one 的 Vue 对象中定义的,所以不能访问 -->
</div>

<script>
new Vue({
el: '#app-one',
data: {
buttonText: '按钮一'
},
components: {
'x-button': {
props: ['text'],
template: '<button>{{text}}</button>'
}
}
});

new Vue({
el: '#app-two',
data: {
buttonText: '按钮二'
},
});
</script>
</body>

使用 v-model 双向绑定

双向绑定的 v-model 只是一个语法糖,相当于同时使用 v-bind:value 和 v-on:input,也可以使用组件的 model 对象自定义 v-bind 的属性和 v-on 的事件名字,可参考 v-model 指令在组件中怎么玩 了解更多:

1
2
3
4
5
6
7
8
9
props: {
html: String,
attachments: Array,
closable: { type: Boolean, default: false } // 默认为不可关闭
},
model: {
prop: 'html', // props 中定义的变量
event: 'editingFinished' // this.$emit('editingFinished', something) 发射的事件名字
}

v-model 只是一个语法糖,实际的含义是:

1
2
3
4
<a-select
v-bind:value="parentValue"
v-on:input="parentValue = arguments[0]">
</a-select>