The CustomEvent.initCustomEvent()
method initializes a CustomEvent
object. If the event has already been dispatched, this method does nothing.
Events initialized in this way must have been created with the Document.createEvent()
method. This method must be called to set the event before it is dispatched, using EventTarget.dispatchEvent()
. Once dispatched, it doesn't do anything anymore.
Do not use this method anymore, as it is deprecated.
Note: Rather than using the feature, instead use specific event constructors, like CustomEvent()
. The page on Creating and triggering events gives more information about the way to use those.
Syntax
event.initCustomEvent(type, canBubble, cancelable, detail);
Parameters
type
- Is a
DOMString
containing the name of the event. canBubble
- Is a
Boolean
indicating whether the event bubbles up through the DOM or not. cancelable
- Is a
Boolean
indicating whether the event is cancelable. detail
- The data passed when initializing the event.
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'CustomEvent' in that specification. |
Living Standard | Initial definition, but already deprecated in favor of the use of a constructor, CustomEvent() |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
initCustomEvent | Chrome
Full support
Yes
| Edge Full support 14 | Firefox Full support 6 | IE Full support 9 | Opera Full support 11 | Safari Full support 5.1 | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android Full support 6 | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android
Full support
Yes
|
Legend
- Full support
- Full support
- Deprecated. Not for use in new websites.
- Deprecated. Not for use in new websites.
- See implementation notes.
- See implementation notes.
See also
CustomEvent
- The constructor to use instead of this deprecated method:
CustomEvent()
.