The detail
readonly property of the
CustomEvent
interface returns any data passed when initializing the
event.
Note:
This feature is available in Web Workers.Syntax
let myDetail = customEventInstance.detail;
Return value
Whatever data the event was initialized with.
Example
// add an appropriate event listener
obj.addEventListener("cat", function(e) { process(e.detail) });
// create and dispatch the event
let event = new CustomEvent("cat", {
detail: {
hazcheeseburger: true
}
});
obj.dispatchEvent(event);
// Will return an object contaning the hazcheeseburger property
let myDetail = event.detail;
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'detail' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
BCD tables only load in the browser