CompositionEvent: CompositionEvent() constructor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2017.

The CompositionEvent() constructor creates a new CompositionEvent object.

Syntax

js
new CompositionEvent(type)
new CompositionEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to compositionstart, compositionupdate, or compositionend.

options Optional

An object that, in addition of the properties defined in UIEvent(), has the following properties:

data Optional

A string used to initialize the data property of the new CompositionEvent. Browser-generated events set it to the characters generated by the IME composition.

Return value

A new CompositionEvent object.

Specifications

Specification

UI Events
# dom-compositionevent-compositionevent

Browser compatibility

Enable JavaScript to view this browser compatibility table.

Help improve MDN

Was this page helpful to you?

Yes No

Learn how to contribute

This page was last modified on Apr 7, 2023 by MDN contributors.

View this page on GitHub • Report a problem with this content

UI Events
CompositionEvent
Constructor
1. CompositionEvent()
Instance properties
1. data
2. locale
Instance methods
1. initCompositionEvent()
Inheritance
1. UIEvent
2. Event
Related pages for UI Events
Guides
1. Code values for keyboard events
2. Key values for keyboard events