如何通过 new CustomEvent 创建携带业务数据的自定义事件

酷浩同学_8891

酷浩同学_8891

2026-05-14

122人浏览

原创

用 new customevent 创建自定义事件时,必须通过 detail 选项传入业务数据,再调用 dispatchevent 触发;监听方从 event.detail 安全读取,detail 是唯一推荐的数据载体,支持任意类型但需注意跨上下文限制。

如何通过 new customevent 创建携带业务数据的自定义事件

用 new CustomEvent 创建携带业务数据的自定义事件,关键在于正确使用 detail 选项传入任意结构的数据对象,再通过 dispatchEvent 触发,监听方从事件对象的 detail 属性中读取。

detail 是唯一推荐的数据载体

CustomEvent 构造函数支持一个可选的配置对象,其中 detail 是唯一用于传递自定义业务数据的字段。它没有类型限制,可以是字符串、数字、数组、普通对象,甚至 Class 实例(需注意序列化限制)。

  • ✅ 推荐写法:new CustomEvent('user-login', { detail: { id: 123, name: 'Alice', roles: ['admin'] } })
  • ❌ 避免在 detail 外额外挂属性,比如 { detail: ..., userId: 456 } —— 这些不会被自动注入到事件实例上
  • ⚠️ 注意:detail 中若含函数、DOM 节点或循环引用,在跨上下文(如 iframe、Web Worker)传递时可能丢失或报错

触发事件要绑定到有效目标节点

自定义事件需调用 dispatchEvent 方法才能真正发出,且必须作用于一个有效的 DOM 节点(如 document、window 或某个元素),不能直接对事件对象调用。

  • 常见目标选择:document.dispatchEvent(evt)(全局广播)、myButton.dispatchEvent(evt)(组件内通信)
  • 确保目标节点已存在于 DOM 中,否则会静默失败(不报错但监听器收不到)
  • 如果需要冒泡,构造时设 bubbles: true;需要被 stopPropagation() 拦截,就设 cancelable: true

监听时从 event.detail 安全取值

监听函数中,业务数据始终位于 event.detail,建议做存在性判断,避免因未传参导致 undefined 报错。

  • 基础监听写法:document.addEventListener('user-login', e => console.log(e.detail.name))
  • 防御性写法:const data = e.detail ?? {}; console.log(data.id || 'unknown')
  • 配合 TypeScript 可定义接口增强类型提示,例如:interface LoginDetail { id: number; name: string; },然后 e.detail as LoginDetail

实际小例子:登录成功后通知全局

假设用户登录完成,前端需要通知多个模块更新状态:

// 发送方(如登录表单提交后)
const loginSuccess = new CustomEvent('auth-success', {
  detail: { token: 'abc123', user: { id: 789, avatar: '/u.png' } },
  bubbles: true
});
document.dispatchEvent(loginSuccess);
// 监听方(如用户头像组件)
document.addEventListener('auth-success', e => {
  const { token, user } = e.detail;
  localStorage.setItem('auth-token', token);
  renderAvatar(user.avatar);
});
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3269

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2348

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1280

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2218

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3560

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16375

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.8万人学习