CustomEvent: detail property
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.
Note: This feature is available in Web Workers.
The read-only detail property of the CustomEvent interface returns any data passed when initializing the event.
Value
Whatever data the event was initialized with.
Example
js
// 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
Specifications
| Specification |
|---|
| DOM # ref-for-dom-customevent-detail2 |
Browser compatibility
Enable JavaScript to view this browser compatibility table.