The DOM CompositionEvent represents events that occur due to the user indirectly entering text.

Documentation CompositionEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:


new(type:String, ?eventInitDict:Null<CompositionEventInit>)





read onlydata:String

Returns the characters generated by the input method that raised the event; its varies depending on the type of event that generated the CompositionEvent object.

read onlylocale:String

Returns the locale of current input method (for example, the keyboard layout locale if the composition is associated with IME).


@:value({ localeArg : "", cancelableArg : false, canBubbleArg : false })initCompositionEvent(typeArg:String, canBubbleArg:Bool = false, cancelableArg:Bool = false, ?viewArg:Window, ?dataArg:String, localeArg:String = ""):Void

Initializes the attributes of a CompositionEvent object.

Inherited Variables

Defined by UIEvent

read onlydetail:Int

Returns a long with details about the event, depending on the event type.

read onlylayerX:Int

Returns the horizontal coordinate of the event relative to the current layer.

read onlylayerY:Int

Returns the vertical coordinate of the event relative to the current layer.

read onlypageX:Int

Returns the horizontal coordinate of the event relative to the whole document.

read onlypageY:Int

Returns the vertical coordinate of the event relative to the whole document.

read onlyrangeOffset:Int

read onlyrangeParent:Node

read onlyview:Window

Returns a WindowProxy that contains the view that generated the event.

read onlywhich:Int

Returns the numeric keyCode of the key pressed, or the character code (charCode) for an alphanumeric key pressed.

Defined by Event

read onlybubbles:Bool

A Boolean indicating whether the event bubbles up through the DOM or not.


A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.

read onlycancelable:Bool

A Boolean indicating whether the event is cancelable.

read onlycomposed:Bool

A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.

read onlycurrentTarget:EventTarget

A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent; it's possible this has been changed along the way through retargeting.

read onlydefaultPrevented:Bool

Indicates whether or not event.preventDefault() has been called on the event.

read onlyeventPhase:Int

Indicates which phase of the event flow is being processed.

read onlyexplicitOriginalTarget:EventTarget

The explicit original target of the event (Mozilla-specific).

read onlyisTrusted:Bool

Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent).

read onlyoriginalTarget:EventTarget

The original target of the event, before any retargetings (Mozilla-specific).


A historical property introduced by Internet Explorer and eventually adopted into the DOM specification in order to ensure existing sites continue to work. Ideally, you should try to use Event.preventDefault() and Event.defaultPrevented instead, but you can use returnValue if you choose to do so.

read onlytarget:EventTarget

A reference to the target to which the event was originally dispatched.

read onlytimeStamp:Float

The time at which the event was created (in milliseconds). By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.

read onlytype:String

The name of the event (case-insensitive).

Inherited Methods

Defined by UIEvent

@:value({ aDetail : 0, aCancelable : false, aCanBubble : false })initUIEvent(aType:String, aCanBubble:Bool = false, aCancelable:Bool = false, ?aView:Window, aDetail:Int = 0):Void

Initializes a UIEvent object. If the event has already being dispatched, this method does nothing.

Defined by Event


Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

@:value({ cancelable : false, bubbles : false })initEvent(type:String, bubbles:Bool = false, cancelable:Bool = false):Void

Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.


Cancels the event (if it is cancelable).


For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)


Stops the propagation of events further along in the DOM.