CustomEvent: CustomEvent() constructor
DOM
DOM
The CustomEvent() constructor creates a new CustomEvent object.
Syntax
new CustomEvent(type)
new CustomEvent(type, options)
Parameters
type- : A string providing the name of the event. Event names are case-sensitive.
options- : An object that, in addition of the properties defined in Event(), can have the following properties:
detail- : An event-dependent value associated with the event. This value is then available to the handler using the CustomEvent.detail property.
It defaults to
null.
Return value
A new CustomEvent object.
Example
// create custom events
const catFound = new CustomEvent("animalfound", {
detail: {
name: "cat",
},
});
const dogFound = new CustomEvent("animalfound", {
detail: {
name: "dog",
},
});
const element = document.createElement("div"); // create a <div> element
// add an appropriate event listener
element.addEventListener("animalfound", (e) => console.log(e.detail.name));
// dispatch the events
element.dispatchEvent(catFound);
element.dispatchEvent(dogFound);
// "cat" and "dog" logged in the console
Additional examples can be found at Creating and dispatching events.
Specifications
Browser compatibility
See also
- CustomEvent
- Creating and dispatching events