CustomEvent
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is available in Web Workers.
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.
Constructor
CustomEvent()-
Creates a new
CustomEvent.
Instance properties
This interface inherits properties from its parent, Event.
CustomEvent.detailRead only-
Returns any data passed when initializing the event.
Instance methods
This interface inherits methods from its parent, Event.
CustomEvent.initCustomEvent()-
Initializes a
CustomEventobject. If the event has already been dispatched, this method does nothing.
Specifications
| Specification |
|---|
| DOM # interface-customevent |
Browser compatibility
| desktop | mobile | server | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CustomEvent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CustomEvent() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
detail
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
initCustomEvent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Available in workers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Deprecated. Not for use in new websites.