CustomEvent

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Note: This feature is available in Web Workers.

The CustomEvent interface represents events initialized by an application for any purpose.

Note: If used to attempt to communicate between a web extension content script and a web page script, a non-string detail property throws with "Permission denied to access property" in Firefox. To avoid this issue clone the object. See Share objects with page scripts for more information.

Event CustomEvent

Constructor

CustomEvent()

Creates a new CustomEvent.

Instance properties

This interface inherits properties from its parent, Event.

CustomEvent.detail Read only

Returns any data passed when initializing the event.

Instance methods

This interface inherits methods from its parent, Event.

CustomEvent.initCustomEvent()

Initializes a CustomEvent object. If the event has already been dispatched, this method does nothing.

Specifications

Specification
DOM Standard
# interface-customevent

Browser compatibility

BCD tables only load in the browser

See also