EditContext: compositionend event

{{APIRef("EditContext API")}}{{SeeCompatTable}}

The compositionend event of the {{domxref("EditContext")}} interface fires when composition using an {{glossary("Input Method Editor")}} (IME) window ends.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

addEventListener("compositionend", (event) => { })

oncompositionend = (event) => { }

Examples

Using compositionend to change the editable region's border

In the following example, the editable region's border is set to red when the compositionstart event fires, and back to black when the compositionend event fires. Note that the event listener callbacks in this example are only called when using an IME window, or other platform-specific editing UI surfaces, to compose text.

#text-editor {
  border: 1px solid black;
}
#text-editor.is-composing {
  border-color: red;
}

<div id="text-editor"></div>

const editorElement = document.getElementById("text-editor");
const editContext = new EditContext();
editorElement.editContext = editContext;

editContext.addEventListener("compositionstart", (event) => {
  editorElement.classList.add("is-composing");
});

editContext.addEventListener("compositionend", (event) => {
  editorElement.classList.remove("is-composing");
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}