CustomEvent.initCustomEvent()

Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Avoid using it and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work 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.

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

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

See also

Document Tags and Contributors

 Contributors to this page: erikadoyle, Jeremie, Sole, fscholz, teoli
 Last updated by: erikadoyle,