EditContext: EditContext() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The EditContext() constructor returns a new EditContext object.

Syntax

new EditContext()
new EditContext(options)

Parameters

options Optional

An optional object with the following properties:

text: A string to set the initial text of the EditContext.
selectionStart: A number to set the initial selection start of the EditContext.
selectionEnd: A number to set the initial selection end of the EditContext.

Examples

Instantiating an `EditContext` object

The following example creates a new EditContext object with the initial text "Hello world!" and the initial selection covering the entire text.

html

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

const initialText = "Hello world!";

const editContext = new EditContext({
  text: initialText,
  selectionStart: 0,
  selectionEnd: initialText.length,
});

const editorElement = document.getElementById("editor");
editorElement.editContext = editContext;

console.log(
  `EditContext object ready. Text: ${editContext.text}. Selection: ${editContext.selectionStart} - ${editContext.selectionEnd}.`,
);

Specifications

Specification
EditContext API # dom-editcontext-constructor

Browser compatibility

BCD tables only load in the browser