ContextQMD
Back to Content

CustomEvent

files/en-us/web/api/customevent/index.md

latest1.6 KB
Original Source

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

The CustomEvent interface can be used to attach custom data to an event generated by an application.

As an alternative to CustomEvent, you can subclass the Event interface to add custom data and behavior.

[!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