在 Vue 中使用 $emit 自定义事件

Vue $emit 允许我们从子组件向其父组件发送自定义事件。

在标准 Vue 流中,这是触发某些事件或从子组件发送数据到父组件的最佳方式。

本文详细介绍 Vue $emit

Vue $emit 是如何工作的?

每个 Vue $emit 调用可以传递两个参数:

  • 事件名称 — 这是我们可以在父组件中监听的事件名
  • 有效 payload 对象 — 我们希望跟随事件一起传递的数据(可选)
$emit('event-name', data)

在代码中使用 Vue $emit 有很多不同的方法:

  • 使用 $emit 内联
  • Options API — this.$emit
  • Composition API — context.emit
  • setup script 语法糖 defineEmits 方法

根据你的情况,每种方法都有自己的优缺点,所以让我们来看看每种方法的一个例子,你可以看到哪种方法适合你。

在 Vue 中使用 $emit 内联事件

在构建自己的自定义表单输入时,您可能希望从组件中发送数据。

<!-- CustomInput.vue -->
<template>
  <input 
    type="text"
    @change='$emit('customChange', $event.target.value)'
  />
</template>

以上存在一个问题,我们将无法监听像 @change 这样的标准输入事件。

假设我们的父组件是这样设置的,监听自定义事件 custom-change 并记录其值。

<template>
  <CustomInput @custom-change="logChange"/>
</template>

<script>
import MyInput from './components/MyInput.vue'
export default {
  components: {
    MyInput
  },
  methods: {
    logChange (event) {
      console.log(event)
    }
  }
}
</script>

为了实现这一点,我们需要自定义文本输入来侦听本地输入事件,然后发出自己的事件。

要实际传递原始更改事件的值,我们需要将带有事件有效负载的自定义事件(在此例中为 event.target.value)作为第二个参数发送。

<template>
  <input type="text" @change="$emit('customChange', $event.target.value)" />
</template>

现在,如果我们输入自定义输入,我们的父组件将正确地记录所有更改。

在 Options API 中以 $emit() 发送事件

与 Vue 3 中的几乎所有内容一样,我们可以选择使用 Options API 或 Composition API 从组件中发送自定义事件

在 Options API 中,可以使用 this 调用 $emit 方法,然后将 e.target.value 传递给它。

<script>
export default {
  methods: {
    customChange (e) {
      this.$emit('customChange', e.target.value)
    }
  }
}
</script>

使用 context.emit 在 Composition API 中发送事件

在 Composition API 中,由于安装程序在创建组件之前运行,因此我们无法访问它。

相反,我们可以使用 setup 函数的第二个参数 context 来访问 emit 方法。

context 还可以获取 soltsattr

两种获取方法:

  • 使用 setup 获取整个 context 对象
  • 仅通过解构 context 获取 emit

我们可以调用与 Options API 完全相同的 emit:创建一个方法,调用 emit,并将参数传递给它!

<script>
export default {
  setup (props, { emit }) {
    const customChange = (e) => {
      emit('customChange', e.target.value)
    }

    return {
      customChange
    }
  }
}
</script>

以上就是 Vue `emit()` 方法发送自定义事件的三种不同方法。

## setup 语法糖

`setup script` 可以通过 `defineEmits` 方法定义 emit 自定义事件。

```vue
<script setup>
  const emit = defineEmits(['customChange'])
  const handleAPI = (e) => {
    emit('customChange', e.target.value)
  }
</script>

监听事件时使用 kebab-case

Vue 官方文档建议在事件名称中使用 kebab-case,即使是在脚本中。如果您使用的是 Vue 2,这一点至关重要

在 Vue2 中,事件名称没有自动将 camelCase 转换为 kebab-casev-on 指令会自动将事件名称转换为小写,因此 camelCase 命名的事件不可能被监听。

例如,如果我们发出一个名为 myEvent 的事件,则侦听 my-event 将不起作用

在 Vue3 中,事件名称(如 propscomponents)可以在不同情况下自动转换。与 props 类似,最好还是坚持每种编程语言的约,在脚本中使用 camelCase,在模板中使用 kebab-case

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容