自定义事件

API (opens new window)

在组件标签v-on绑定的事件是自定义事件

就算是原生事件，绑定了 v-on 后也也变成了自定义事件，必须通过 $emit 派发。

<div id="root">
    <child @click="handleClick"></child> <!--这里click是自定义事件-->
</div>

<script type="text/javascript">
    Vue.component('child', {
        template: '<button>Child</button>',
    })

    var vm = new Vue({
        el: '#root'
        methods: {
            handleClick() {
                alert('click')
            }
        }
    })
</script>

上面这种情况，当点击子组件时并不会触发handleClick()事件，因为此时的click并非原生的点击事件，而是一个自定义事件。

要想触发组件标签中的click事件需要通过子组件$emit来派发

<div id="root">
    <child @click="handleClick"></child> 
</div>

<script type="text/javascript">
    app.component('child', {
        template: '<button @click="handleChildClick">Child</button>', // 这里的click是原生事件
        emits: ['click'], // 在组件上定义发出的事件。
        methods: {
            handleChildClick() {
                this.$emit('click') // 向父组件派发事件
            }
        }
    })

    const vm = Vue.createApp({
        methods: {
            handleClick() { // 子组件触发父组件中的自定义事件 click 后，执行 click 所绑定的 handleClick 事件
                alert('click')
            }
        }
    }).mount('#root')
</script>

上面代码中，子组件内的click是原生点击事件，通过$emit派发click自定义事件触发父组件的handleClick()

对 emits 进行事件验证

与 prop 类型验证类似，如果使用对象语法而不是数组语法定义发出的事件，则可以对它进行验证。

app.component('custom-form', {
  emits: {
    // 没有验证
    click: null,

    // 验证 submit 事件
    submit: ({ email, password }) => {
      if (email && password) {
        return true
      } else {
        console.warn('Invalid submit event payload!')
        return false
      }
    }
  },
  methods: {
    submitForm(email, password) {
      this.$emit('submit', { email, password })
    }
  }
})

使自定义事件变为原生事件

使用.native修饰符把自定义事件变为原生事件

<div id="root">
    <child @click.native="handleClick"></child> <!--自定义事件添加了native修饰符变原生事件-->
</div>

<script type="text/javascript">
    Vue.component('child', {
        template: '<button>Child</button>',
    })

    const vm =Vue.createApp({
        methods: {
            handleClick() {
                alert('click')
            }
        }
    }).mount('#root')
</script>

上面代码中，自定义事件click添加了.native修饰符，使其变为原生事件，从而触发handleClick()。

自定义事件名会自动变小写

当使用camelCase（驼峰）命名的自定义函数

this.$emit('myEvent')

则监听这个名字的 kebab-case（烤串） 版本是不会有任何效果的：

<!-- 没有效果 -->
<my-component v-on:my-event="doSomething"></my-component>

v-on 事件监听器在 DOM 模板中会被自动转换为全小写 (因为 HTML 是大小写不敏感的)，所以 v-on:myEvent 将会变成 v-on:myevent——导致 myEvent 不可能被监听到。

因此，我们推荐你始终使用 kebab-case（烤串） 的事件名。