CustomEvent.detail

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 containing the hazcheeseburger property
let myDetail = event.detail;

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
detail
15
12
11
No
11.6
5
≤37
Yes
14
Yes
5
Yes

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/detail