CustomEvent.detail

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

// create custom events
const catFound = new CustomEvent('animalfound', {
  detail: {
    name: 'cat'
  }
});
const dogFound = new CustomEvent('animalfound', {
  detail: {
    name: 'dog'
  }
});

// add an appropriate event listener
obj.addEventListener('animalfound', (e) => console.log(e.detail.name));

// dispatch the events
obj.dispatchEvent(catFound);
obj.dispatchEvent(dogFound);

// "cat" and "dog" logged in the console

Specifications

Specification
DOM Standard (DOM)
# ref-for-dom-customevent-detail②

Browser compatibility

BCD tables only load in the browser

See also