热搜：编程 Python Microsoft 编程语言 C++

Vue3 $emit用法指南(含选项API、组合API及 setup 语法糖)

发布时间：2023-05-22 11:32:46 来源：互联网

.

枫树林给大地铺上了红色的地毯，秋风一吹，枫叶发出哗啦啦的响声，好似在鼓掌欢庆这丰收的景象。看，那菊花，它们开得多么热烈！距么旺盛！黄的、红的、白的、紫的……一朵朵，一簇簇，迎着秋风，披着寒霜，争妍斗艳，喷芳吐香，开得到处都是，简直成了一个锦簇的世界。

Vue Emit是如何工作的？

当我们 emit 一个事件时，我们用一个或多个参数调用一个方法：

eventName: string - 事件的名称
values: any - 通过事件传递的参数

下面是一个内联 emit的例子，<button @click="$emit('add', Math.random())">。emit一个名为add的事件，并将Math.random()的值作为参数传递出去。

然后，在父组件使用v-on或@指令可以监听我们的自定义添加事件并接收该参数值。

Child.vue

<template>
  <button @click="$emit('add', Math.random())">
    Add Math.random()
  </button>
</template>

在** Parent.vue **中监听：

<script setup>
import { ref } from 'vue'
const count = ref(0)
// 也可以从我们的模板中调用一个函数 `<ChildComponent @add="add" />
// const add = (i) => count.value += i
</script>
<template>
  <ChildComponent @add="(i) => count += i" /> 
  <p>Count: {{ count }}</p>
</template>

每次我们点击按钮，Child.vue 都会 emit 一个 add 事件，并带有一个0到1之间的随机值。然后，Parent.vue 捕捉到这个事件，并将这个值添加到计数中。

可以传递任意多的参数，监听器也会收到所有的参数：

Child - $emit('add', Math.random(), 44, 50)
Parent - @add="(i, j, k) => count += i + j + k"

现在，我们知道如何在我们的模板中 emit 内联事件，但在更复杂的例子中，如果我们从SFC的script 中 emit 一个事件会更好。特别是当我们想在 emit 事件之前执行一些逻辑时，这很有用。

在Vue 3中，我们有2种不同的方法来做到这一点:

选项API - this.$emit
带有setup()的组合API - context.emit
带有<script setup>的组合API - defineEmits()

我们一个一个来看。

选项API - `this.$emit`

在 Vue3 中，我人可以选择使用选项API或组合API。

在选项API中，我们可以调用this.$emit来 emit一个自定义事件。

看下面这个例子在 MyTextInput.vue 中，它包含一个 label 和 input。每当 input 改变时，我们会 emit 一个事件，并将输入的值转成大写作为参数传递出去。

我们可以不从模板中调用$emit，而是调用一个组件方法。在该方法中调用this.$emit并把我们的值传给它。

MyTextInput.vue

<script>
  export default {
      methods: {
          handleChange (event) {
              this.$emit("customChange", event.target.value.toUpperCase())
          }
      }
  }
</script>

<template>
  <div>
    <label>My Custom Input</label>
    <input type="text" placeholder="Custom input!" @input="handleChange" />
  </div>
</template>

在 Parent.vue 中接收：

<script>
  export default {
      methods: {
          handleChange (event) {
              this.$emit("customChange", event.target.value.toUpperCase())
          }
      }
  }
</script>

<template>
  <div>
    <label>My Custom Input</label>
    <input type="text" placeholder="Custom input!" @input="handleChange" />
  </div>
</template>

带有setup()的组合API -context.emit

在组合API中，如果使用setup函数，就不能在用 this,也就是不能调用this.$emit()方法了。

相反，可以使用 setup 方法中的第二个参数 context 来访问 emit 方法。我们可以用之前使用的事件名称和值调用context.emit。

MyTextInput.vue

<script>
  export default {
    // can use the entire context object
    setup (props, context) {
        const handleChange = (event) => {
            context.emit("customChange", event.target.value)
        }
        return {
            handleChange
        }
    },
    // or we can destructure it and get `emit`
    setup (props, { emit }) { 
        const handleChange = (event) => {
            emit("customChange", event.target.value)
        }
        return {
            handleChange
        }
    }
  }
</script>

<template>
  <div>
    <label>My Custom Input</label>
    <input type="text" placeholder="Custom input!" @input="handleChange" />
  </div>
</template>

在 <script setup> 中的用法

当我们使用<script setup>时，我们无法访问组件实例或 context 上下文参数。那我们怎么获得 emit ?

在这种情况下，我们可以使用 defineEmits:

指定组件要 emit 事件
为每个事件添加验证信息
可以访问与context.emit相同的值

在最简单的情况下，defineEmits是一个字符串数组，每个字符串是一个事件的名称。

MyTextInput.vue

<script setup>
const emit = defineEmits(['customChange'])

const handleChange = (event) => {
  emit('customChange', event.target.value.toUpperCase())
}
</script>

然而，如果我们传递一个对象，我们可以为每个事件添加一个验证器函数，我们可以在里面检查值是否是我们所需要的格式。

像事件监听器一样，验证器接受我们传入所有参数。

这与prop validation 类似，如果我们的验证器返回 false，会在控制台得到一个警告，这为我们提供了一些有用的信息。

MyTextInput.vue

<script setup>
const emit = defineEmits({
  unvalidatedEvent: null, // if we want an event without validation
  customChange: (s) => {
    if (s && typeof s === 'string') {
      return true
    } else {
      console.warn(`Invalid submit event payload!`)
      return false
    }
  },
})

const handleChange = (event) => {
  // no console warning
  emit('customChange', event.target.value.toUpperCase())
}

onMounted(() => {
  emit('customChange', 1) // not a string, warning!
})
</script>

最佳实践

使用 emits 定义自定义事件

如果我们不使用defineEmits，我们仍然可以通过export default中定义emits选项来跟踪一个组件的自定义事件。

这对保持良好的组件文档很重要，如果我们试图使用一个没有在 emits 中声明的事件，也会从Vue那里得到错误。

当在 emits 选项中定义了原生事件 (如 change) 时，将使用组件中的事件替代原生事件侦听器。

<script>
  export default {
      emits: ["change"] // or can pass object with validators
  }
</script>
<template>
  <div>
    <label>My Custom Input</label>
    <input
      type="text"
      placeholder="Custom input!"
      @input='$emit("change", $event.target.value)'
    />
  </div>
</template>