2020-08-21

Vue 学习笔记（十）：自定义事件

自定义事件 Custom Events

事件名不存在任何自动化的大小写转换（与组件和prop不同），需要严格匹配，需要使用 kebab-case 的事件名

自定义组件的 `v-model`

组件上的 v-model 默认会利用 value prop 和 input 事件，但单选框、复选框等输入控件可能会将 value attribute 用于不同的目的。此时可用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 时：

1	<base-checkbox v-model="lovingVue"></base-checkbox>

lovingVue 的值会传入 prop checked 。并且当 <base-checkbox> 触发一个 change 事件并附带一个新值的时候，这个 lovingVue 的 property 将会被更新。

注意仍然需要在组件的 props 选项里声明 checked 这个 prop

将原生事件绑定到组件

Binding Native Events to Components
使用 v-on 的 .native 修饰符可以在一个组件的根元素上直接监听一个原生事件

1	<base-input v-on:focus.native="onFocus"></base-input>

但是 <base-input> 组件可能做了如下重构，所以根元素实际上是一个 <label> 元素，此时父级的 .native 监听器将静默失败，没有报错但 onFocus 无效。

<label>
  {{ label }}
  <input
    v-bind="$attrs"
    v-bind:value="value"
    v-on:input="$emit('input', $event.target.value)"
  >
</label>

对此，Vue 提供了 $listeners property，它是一个对象，里面包含了作用在这个组件上的所有监听器。例如：

{
  focus: function (event) { /* ... */ }
  input: function (value) { /* ... */ },
}

有了 $listeners property，就可以配合 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> 元素一样使用了：所有跟它相同的 attribute 和监听器都可以工作，不必再使用 .native 监听器。

`.sync` 修饰符

有时需要对 prop 进行“双向绑定”。
不过，真正的双向绑定会带来维护上的问题，因为子组件可以变更父组件，且在父组件和子组件都没有明显的变更来源。

推荐以 update:myPropName 的模式触发事件取而代之。例如，在一个包含 title prop 组件中，可以用以下方法表达对其赋新值的意图：

1	this.$emit('update:title', newTitle)

然后父组件可以监听那个事件并根据需要更新一个本地的数据 property。例如：

<text-document
  v-bind:title="doc.title"
  v-on:update:title="doc.title = $event"
></text-document>

为了方便起见，我们为这种模式提供一个缩写，即 .sync 修饰符：

1	<text-document v-bind:title.sync="doc.title"></text-document>

注意带有 .sync 修饰符的 v-bind 不能和表达式一起使用 (例如 v-bind:title.sync="doc.title + '!'" 是无效的)。只能提供想要绑定的 property 名，类似 v-model

当一个对象同时设置多个 prop 的时候，可将 .sync 修饰符和 v-bind 配合使用：

1	<text-document v-bind.sync="doc"></text-document>

这样会把 doc 对象中的每一个 property (如 title) 都作为一个独立的 prop 传进去，然后各自添加用于更新的 v-on 监听器。

将 v-bind.sync 用在一个字面量的对象上，例如 v-bind.sync="{ title: doc.title }"，是无法正常工作的，因为在解析一个这样的复杂表达式的时候，有很多边缘情况需要考虑。

自定义组件的 v-model

将原生事件绑定到组件

.sync 修饰符

自定义组件的 `v-model`

`.sync` 修饰符