|
| 1 | +--- |
| 2 | +title: 自定义事件 |
| 3 | +type: guide |
| 4 | +order: 103 |
| 5 | +--- |
| 6 | + |
| 7 | +> 该页面假设你已经阅读过了[组件基础](components.html)。如果你还对组件不太了解,推荐你先阅读它。 |
| 8 | +
|
| 9 | +## 事件名 |
| 10 | + |
| 11 | +跟组件和 prop 不同,事件名不存在任何自动化的大小写转换。而是触发的事件名需要完全匹配监听这个事件所用的名称。举个例子,如果触发一个 camelCase 名字的事件: |
| 12 | + |
| 13 | +```js |
| 14 | +this.$emit('myEvent') |
| 15 | +``` |
| 16 | + |
| 17 | +则监听这个名字的 kebab-case 版本是不会有任何效果的: |
| 18 | + |
| 19 | +```html |
| 20 | +<my-component v-on:my-event="doSomething"></my-component> |
| 21 | +``` |
| 22 | + |
| 23 | +跟组件和 prop 不同,事件名不会被用作一个 JavaScript 变量名或属性名,所以就没有理由使用 camelCase 或 PascalCase 了。并且 `v-on` 事件监听器在 DOM 模板中会被自动转换为全小写 (因为 HTML 是大小写不敏感的),所以 `v-on:myEvent` 将会变成 `v-on:myevent`——导致 `myEvent` 不可能被监听到。 |
| 24 | + |
| 25 | +因此,我们推荐你**始终使用 kebab-case 的事件名**。 |
| 26 | + |
| 27 | +## 自定义组件的 `v-model` |
| 28 | + |
| 29 | +> 2.2.0+ 新增 |
| 30 | +
|
| 31 | +一个组件上的 `v-model` 默认会利用名为 `value` 的 prop 和名为 `input` 的事件,但是像单选框、复选框等类型的输入控件可能会将 `value` 特性用于[不同的目的](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#Value)。`model` 选项可以用来避免这样的冲突: |
| 32 | + |
| 33 | +```js |
| 34 | +Vue.component('base-checkbox', { |
| 35 | + model: { |
| 36 | + prop: 'checked', |
| 37 | + event: 'change' |
| 38 | + }, |
| 39 | + props: { |
| 40 | + checked: Boolean |
| 41 | + }, |
| 42 | + template: ` |
| 43 | + <input |
| 44 | + type="checkbox" |
| 45 | + v-bind:checked="checked" |
| 46 | + v-on:change="$emit('change', $event.target.checked)" |
| 47 | + > |
| 48 | + ` |
| 49 | +}) |
| 50 | +``` |
| 51 | + |
| 52 | +现在在这个组件上使用 `v-model` 当时候: |
| 53 | + |
| 54 | +```js |
| 55 | +<base-checkbox v-model="lovingVue"></base-checkbox> |
| 56 | +``` |
| 57 | + |
| 58 | +这里的 `lovingVue` 的值将会传入这个名为 `checked` 的 prop。同时当 `<base-checkbox>` 触发一个 `change` 事件并附带一个新的值的时候,这个 `lovingVue` 的属性将会被更新。 |
| 59 | + |
| 60 | +<p class="tip">注意你仍然需要在组件的 <code>props</code> 选项里声明 <code>checked</code> 这个 prop。</p> |
| 61 | + |
| 62 | +## 将原生事件绑定到组件 |
| 63 | + |
| 64 | +你可能有很多次想要在一个组件的根元素上直接监听一个原生事件。这时,你可以使用 `v-on` 的 `.native` 修饰符: |
| 65 | + |
| 66 | +```html |
| 67 | +<base-input v-on:focus.native="onFocus"></base-input> |
| 68 | +``` |
| 69 | + |
| 70 | +在有的时候这是很有用的,不过在你尝试监听一个类似 `<input>` 的非常特定的元素时,这并不是个好主意。比如上述 `<base-input>` 组件可能做了如下重构,所以根元素实际上是一个 `<label>` 元素: |
| 71 | + |
| 72 | +```html |
| 73 | +<label> |
| 74 | + {{ label }} |
| 75 | + <input |
| 76 | + v-bind="$attrs" |
| 77 | + v-bind:value="value" |
| 78 | + v-on:input="$emit('input', $event.target.value)" |
| 79 | + > |
| 80 | +</label> |
| 81 | +``` |
| 82 | + |
| 83 | +这时,父级的 `.native` 监听器将静默失败。它不会产生任何报错,但是 `onFocus` 处理函数不会如你预期地被调用。 |
| 84 | + |
| 85 | +为了解决这个问题,Vue 提供了一个 `$listeners` 属性,它是一个对象,里面包含了作用在这个组件上的所有监听器。例如: |
| 86 | + |
| 87 | +```js |
| 88 | +{ |
| 89 | + focus: function (event) { /* ... */ } |
| 90 | + input: function (value) { /* ... */ }, |
| 91 | +} |
| 92 | +``` |
| 93 | + |
| 94 | +有了这个 `$listeners` 属性,你就可以配合 `v-on="$listeners"` 将所有的事件监听器指向这个组件的某个特定的子元素。对于类似 `<input>` 的你希望它也可以配合 `v-model` 工作的组件来说,为这些监听器创建一个类似下述 `inputListeners` 的计算属性通常是非常有用的: |
| 95 | + |
| 96 | +```js |
| 97 | +Vue.component('base-input', { |
| 98 | + inheritAttrs: false, |
| 99 | + props: ['label', 'value'], |
| 100 | + computed: { |
| 101 | + inputListeners: function () { |
| 102 | + var vm = this |
| 103 | + // `Object.assign` 将所有的对象合并为一个新对象 |
| 104 | + return Object.assign({}, |
| 105 | + // 我们从父级添加所有的监听器 |
| 106 | + this.$listeners, |
| 107 | + // 然后我们添加自定义监听器, |
| 108 | + // 或覆写一些监听器的行为 |
| 109 | + { |
| 110 | + // 这里确保组件配合 `v-model` 的工作 |
| 111 | + input: function (event) { |
| 112 | + vm.$emit('input', event.target.value) |
| 113 | + } |
| 114 | + } |
| 115 | + ) |
| 116 | + } |
| 117 | + }, |
| 118 | + template: ` |
| 119 | + <label> |
| 120 | + {{ label }} |
| 121 | + <input |
| 122 | + v-bind="$attrs" |
| 123 | + v-bind:value="value" |
| 124 | + v-on="inputListeners" |
| 125 | + > |
| 126 | + </label> |
| 127 | + ` |
| 128 | +}) |
| 129 | +``` |
| 130 | + |
| 131 | +现在 `<base-input>` 组件是一个**完全透明的包裹器**了,也就是说它可以完全像一个普通的 `<input>` 元素一样使用了:所有跟它相同的特性和监听器的都可以工作。 |
| 132 | + |
| 133 | +## `.sync` 修饰符 |
| 134 | + |
| 135 | +> 2.3.0+ 新增 |
| 136 | +
|
| 137 | +在有些情况下,我们可能需要对一个 prop 进行“双向绑定”。不幸的是,真正的双向绑定会带来维护上的问题,因为子组件可以修改父组件,且在父组件和子组件都没有明显的改动来源。 |
| 138 | + |
| 139 | +这也是为什么我们推荐以 `update:my-prop-name` 的模式触发事件取而代之。举个例子,在一个包含 `title` prop 的假设的组件中,我们可以用以下方法表达对其赋新值的意图: |
| 140 | + |
| 141 | +```js |
| 142 | +this.$emit('update:title', newTitle) |
| 143 | +``` |
| 144 | + |
| 145 | +然后父组件可以监听那个事件并根据需要更新一个本地的数据属性。例如: |
| 146 | + |
| 147 | +```html |
| 148 | +<text-document |
| 149 | + v-bind:title="doc.title" |
| 150 | + v-on:update:title="doc.title = $event" |
| 151 | +></text-document> |
| 152 | +``` |
| 153 | + |
| 154 | +为了方便起见,我们为这种模式提供一个缩写,即 `.sync` 修饰符: |
| 155 | + |
| 156 | +```html |
| 157 | +<text-document v-bind:title.sync="doc.title"></text-document> |
| 158 | +``` |
| 159 | + |
| 160 | +当我们用一个对象同时设置多个 prop 的时候,也可以将这个 `.sync` 修饰符和 `v-bind` 配合使用: |
| 161 | + |
| 162 | +```html |
| 163 | +<text-document v-bind.sync="doc"></text-document> |
| 164 | +``` |
| 165 | + |
| 166 | +这样会把 `doc` 对象中的每一个属性 (如 `title`) 都作为一个独立的 prop 传进去,然后各自添加用于更新的 `v-on` 监听器。 |
| 167 | + |
| 168 | +<p class="tip">将 <code>v-bind.sync</code> 用在一个字面量的对象上,例如 <code>v-bind.sync="{ title: doc.title }"</code>,是无法正常工作的,因为在解析一个像这样的复杂表达式的时候,有很多边缘情况需要考虑。</p> |
0 commit comments