CustomEvent

{{APIRef("DOM")}} {{AvailableInWorkers}} 

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.

{{InheritanceDiagram}} 

Constructor

• {{domxref("CustomEvent.CustomEvent", "CustomEvent()")}} 
  • : Creates a new CustomEvent.

Instance properties

This interface inherits properties from its parent, {{domxref("Event")}} .

• {{domxref("CustomEvent.detail")}}  {{ReadOnlyInline}} 
  • : Returns any data passed when initializing the event.

Instance methods

This interface inherits methods from its parent, {{domxref("Event")}} .

• {{domxref("CustomEvent.initCustomEvent()")}}  {{deprecated_inline}} 
  • : Initializes a CustomEvent object. If the event has already been dispatched, this method does nothing.

Specifications

{{Specifications}} 

Browser compatibility

{{Compat}} 

See also

• {{domxref("Window.postMessage()")}} 
• Creating and triggering events