自定义组件
事件名
始终使用 kebab-case(短横线命名) 的事件名。
<my-component v-on:my-event="doSomething"></my-component>
this.$emit('my-event')
自定义组件的 v-model---2.2.0+ 新增
一个组件上的
v-model
默认会利用名为value
的 prop 和名为input
的事件,但是像单选框、复选框等类型的输入控件可能会将value
特性用于不同的目的。model
选项可以用来避免这样的冲突:Vue.component('base-checkbox', { model: { prop: 'checked', event: 'change' }, props: { checked: Boolean }, template: ` <input type="checkbox" v-bind:checked="checked" v-on:change="$emit('change', $event.target.checked)" > ` })
现在在这个组件上使用
v-model
的时候:<base-checkbox v-model="lovingVue"></base-checkbox>
这里的
lovingVue
的值将会传入这个名为checked
的 prop。同时当<base-checkbox>
触发一个change
事件并附带一个新的值的时候,这个lovingVue
的属性将会被更新。注意你仍然需要在组件的
props
选项里声明checked
这个 prop。
将原生事件绑定到组件
$listeners
属性,它是一个对象,里面包含了作用在这个组件上的所有监听器。例如:{ focus: function (event) { /* ... */ } input: function (value) { /* ... */ }, }
$listeners 属性,配合 v-on="$listeners" 将所有的事件监听器指向这个组件的某个特定的子元素。对于类似 <input> 的你希望它也可以配合 v-model 工作的组件来说,为这些监听器创建一个类似下述 inputListeners 的计算属性通常是非常有用的:
Vue.component('base-input', { inheritAttrs: false, props: ['label', 'value'], computed: { inputListeners: function () { var vm = this // `Object.assign` 将所有的对象合并为一个新对象 return Object.assign({}, // 我们从父级添加所有的监听器 this.$listeners, // 然后我们添加自定义监听器, // 或覆写一些监听器的行为 { // 这里确保组件配合 `v-model` 的工作 input: function (event) { vm.$emit('input', event.target.value) } } ) } }, template: ` <label> {{ label }} <input v-bind="$attrs" v-bind:value="value" v-on="inputListeners" > </label> ` })
现在
<base-input>
组件是一个完全透明的包裹器了,也就是说它可以完全像一个普通的<input>
元素一样使用了:所有跟它相同的特性和监听器的都可以工作。
.sync 修饰符----2.3.0+ 新增
在有些情况下,我们可能需要对一个 prop 进行“双向绑定”。不幸的是,真正的双向绑定会带来维护上的问题,因为子组件可以修改父组件,且在父组件和子组件都没有明显的改动来源。
这也是为什么我们推荐以
update:myPropName
的模式触发事件取而代之。举个例子,在一个包含title
prop 的假设的组件中,我们可以用以下方法表达对其赋新值的意图:this.$emit('update:title', newTitle)
然后父组件可以监听那个事件并根据需要更新一个本地的数据属性。例如:
<text-document v-bind:title="doc.title" v-on:update:title="doc.title = $event" ></text-document>
为了方便起见,我们为这种模式提供一个缩写,即
.sync
修饰符:<text-document v-bind:title.sync="doc.title"></text-document>
注意带有
.sync
修饰符的v-bind
不能和表达式一起使用 (例如v-bind:title.sync=”doc.title + ‘!’”
是无效的)。取而代之的是,你只能提供你想要绑定的属性名,类似v-model
。当我们用一个对象同时设置多个 prop 的时候,也可以将这个
.sync
修饰符和v-bind
配合使用:<text-document v-bind.sync="doc"></text-document>
这样会把
doc
对象中的每一个属性 (如title
) 都作为一个独立的 prop 传进去,然后各自添加用于更新的v-on
监听器。将
v-bind.sync
用在一个字面量的对象上,例如v-bind.sync=”{ title: doc.title }”
,是无法正常工作的,因为在解析一个像这样的复杂表达式的时候,有很多边缘情况需要考虑。