This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Do not use it in old or new projects. Pages or Web apps using it may break at any time.

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.

Instead use specific event constructors, like CustomEvent(). The page on Creating and triggering events gives more information about the way to use these.


event.initCustomEvent(type, canBubble, cancelable, detail);


Is a DOMString containing the name of the event.
Is a Boolean indicating whether the event bubbles up through the DOM or not.
Is a Boolean indicating whether the event is cancelable.
The data passed when initializing the event.


Specification Status Comment
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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) 6 (6) 9 11 5.1 (533.3)
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support ? 6.0 (6) ? ? ?

See also


© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.

API CustomEvent Deprecated DOM Method Reference Référence