Vue 3 自定义事件

自定义事件

除了系统自带的原生 DOM 自带的事件以外，有时候咱们须要用到这些自带的事件以外，咱们就必需要自定义事件了。

事件名

不一样于组件和 prop，事件名不存在任何自动化的大小写转换。而是触发的事件名须要彻底匹配监听这个事件所用的名称。举个例子，若是触发一个 camelCase 名字的事件，咱们仍是接着昨天的项目继续往下写，在 TestCom.vue 使用 button 按钮点击事件分发一个 click-event 事件，不一样于组件和 prop，事件名不会被用做一个 JavaScript 变量名或 property 名，因此就没有理由使用 camelCase 或 PascalCase 了。而且 v-on 事件监听器在 DOM 模板中会被自动转换为全小写 (由于 HTML 是大小写不敏感的)，因此 @myEvent 将会变成 @myevent——致使 myEvent 不可能被监听到。

<template>
  <div class="test-com-wrap">
    {{ title }}
    <button @click="click">按钮</button>
  </div>
</template>
<script>
export default {
  name: "TestCom",
  props: {
    title: {
      type: String,
      default: "",
    },
  },
  created() {
    console.log(this.$attrs)
  },
  methods: {
    click(e) {
      this.$emit('click-event', e)
    }
  }
};
</script>

而后咱们在 TemplateM.vue 来接收这个事件：

<template>
  <div class="template-m-wrap">
    <test-com
      title="这个是组件"
      data-status="active"
      @click-event="clickEvent"
    ></test-com>
  </div>
</template>
<script>
import TestCom from "./TestCom";
export default {
  name: "TemplateM",
  components: {
    TestCom,
  },
  data() {
    return {};
  },
  methods: {
    clickEvent(e) {
      console.log("e===>", e.target)
    }
  },
};
</script>

查看浏览效果：

定义自定义事件

继续上面的代码，能够经过 emits 选项在组件上定义已经发出的事件：

<template>
  <div class="test-com-wrap">
    {{ title }}
    <button @click="click">按钮</button>
  </div>
</template>
<script>
export default {
  name: "TestCom",
  props: {
    title: {
      type: String,
      default: "",
    },
  },
  emits: ['click-event'],
  created() {
    console.log(this.$attrs)
  },
  methods: {
    click(e) {
      this.$emit('click-event', e)
    }
  }
};
</script>

验证抛出的事件

与 prop 类型验证相似，若是使用对象语法而不是数组语法定义发出的事件，则能够验证它。

要添加验证，将为事件分配一个函数，该函数接收传递给 $emit 调用的参数，并返回一个布尔值以指示事件是否有效，在 main.js 写下以下代码：

import { createApp } from 'vue/dist/vue.esm-bundler.js'
import App from './App.vue'
import router from './router'
import store from './store'
let app = createApp(App)
app.use(store).use(router).mount('#app')
app.component('custom-form', {
  template: `<div>
    <input v-model="email" type="text" placeholder="输入邮箱"/>
    <input v-model="password" type="password" placeholder="输入密码"/>
    <button @click="submitForm({email, password})">提交</button>
  </div>`,
  data() {
    return {
      email: '',
      password: ''
    }
  },
  emits: {
    // 没有验证
    click: null,

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

在 TemplateM.vue 写下代码：

<template>
  <div class="template-m-wrap">
    <custom-form @submit="submit"></custom-form>
  </div>
</template>
<script>
export default {
  name: "TemplateM",
  components: {
    
  },
  data() {
    return {};
  },
  methods: {
    submit(options) {
      console.log(options)
    }
  },
};
</script>

咱们查看效果以下：

v-model 参数

在本例中，子组件将须要一个 foo prop 并发出 update:foo 要同步的事件，仍是在 main.js ：

import { createApp } from 'vue/dist/vue.esm-bundler.js'
import App from './App.vue'
import router from './router'
import store from './store'
let app = createApp(App)
app.use(store).use(router).mount('#app')
app.component('my-component', {
  props: {
    foo: String
  },
  template: `
    <input 
      type="text"
      :value="foo"
      @input="$emit('update:foo', $event.target.value)">
  `
})

默认状况下，组件上的 v-model 使用 modelValue 做为 prop 和 update:modelValue 做为事件。咱们能够经过向 v-model 传递参数来修改这些名称：

<template>
  <div class="template-m-wrap">
    <my-component v-model:foo="bar"></my-component>
  </div>
</template>
<script>
export default {
  name: "TemplateM",
  components: {
    
  },
  data() {
    return {
      bar: 'dsdsdd'
    };
  },
  methods: {
    submit(options) {
      console.log(options)
    }
  },
};
</script>

查看效果以下：

多个 v-model 绑定

经过利用以特定 prop 和事件为目标的能力，正如咱们以前在 v-model 参数中所学的那样，咱们如今能够在单个组件实例上建立多个 v-model 绑定。

每一个 v-model 将同步到不一样的 prop，而不须要在组件中添加额外的选项：

import { createApp } from 'vue/dist/vue.esm-bundler.js'
import App from './App.vue'
import router from './router'
import store from './store'
let app = createApp(App)
app.use(store).use(router).mount('#app')
app.component('user-name', {
  props: {
    firstName: String,
    lastName: String
  },
  template: `
    <input 
      type="text"
      :value="firstName"
      @input="$emit('update:firstName', $event.target.value)">

    <input
      type="text"
      :value="lastName"
      @input="$emit('update:lastName', $event.target.value)">
  `
})

在 TemplateM.vue :

<template>
  <div class="template-m-wrap">
    <user-name
      v-model:first-name="firstName"
      v-model:last-name="lastName"
    ></user-name>
  </div>
</template>
<script>
export default {
  name: "TemplateM",
  components: {
    
  },
  data() {
    return {
      firstName: 'dsdsdd',
      lastName: 'Ken'
    };
  },
  methods: {
    submit(options) {
      console.log(options)
    }
  },
};
</script>

效果以下：

本文分享自微信公众号 - 人生代码（lijinwen1996329ken）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。