CustomEvent:CustomEvent() 构造函数

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

CustomerEvent() 构造函数创建一个新的 CustomEvent 对象。

语法

js
new CustomEvent(type)
new CustomEvent(type, options)

参数

type

提供事件名称的字符串。事件名称区分大小写。

options 可选

一个对象,Event() 中定义的属性外,该对象还可以具有以下属性:

detail 可选

与事件相关联的事件相关值。处理器可使用 CustomEvent.detail 属性获取该值。默认为 null

返回值

一个新的 CustomEvent 对象。

示例

js
// 创建自定义事件
const catFound = new CustomEvent("animalfound", {
  detail: {
    name: "猫",
  },
});
const dogFound = new CustomEvent("animalfound", {
  detail: {
    name: "狗",
  },
});

// 添加合适的事件监听器
obj.addEventListener("animalfound", (e) => console.log(e.detail.name));

// 触发事件
obj.dispatchEvent(catFound);
obj.dispatchEvent(dogFound);

// 控制台中输出“猫”和“狗”

额外的示例可以在创建和触发事件中找到。

规范

Specification
DOM
# ref-for-dom-customevent-customevent

浏览器兼容性

BCD tables only load in the browser

参见