EditContext
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 interface represents the text edit context of an element that was made editable by using the EditContext API.
The EditContext API can be used to build rich text editors on the web that support advanced text input experiences, such as Input Method Editor (IME) composition, emoji picker, or any other platform-specific editing-related UI surfaces.
Constructor
EditContext()-
Returns a new
EditContextinstance.
Instance properties
EditContext.textRead only-
The editable content of the element.
EditContext.selectionStartRead only-
The offset, within the editable text content, of the start of the current selection.
EditContext.selectionEndRead only-
The offset, within the editable text content, of the end of the current selection.
EditContext.characterBoundsRangeStartRead only-
The offset, within the editable text content, where the last IME composition started.
Instance methods
EditContext is based on the EventTarget interface, and includes its methods.
EditContext.attachedElements()-
An
Arraycontaining oneHTMLElementobject which is the element that's associated with theEditContextobject. EditContext.characterBounds()-
The list of bounding rectangles for the characters in the
EditContextobject. EditContext.updateText()-
Updates the internal text content of the
EditContextobject. EditContext.updateSelection()-
Updates the internal state of the selection within the editable text context.
EditContext.updateControlBounds()-
Informs the operating system about the position and size of the editable text region.
EditContext.updateSelectionBounds()-
Informs the operating system about the position and size of the selection within the editable text region.
EditContext.updateCharacterBounds()-
Informs the operating system about the position and size of the characters in the
EditContextobject.
Events
textupdate-
Fired when the user has made changes to the text or selection.
textformatupdate-
Fired when composition using an Input Method Editor (IME) window is happening and the IME decides that certain parts of the text being composed should be formatted differently to indicate the composition state.
characterboundsupdate-
Fired when the operating system needs to know the size and position of certain characters within the editable text region of the
EditContextobject, in order to display an IME window. compositionstart-
Fired when composition using an IME window is starting.
compositionend-
Fired when composition using an IME window is ending.
Specifications
| Specification |
|---|
| EditContext API # dom-editcontext |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
EditContext
|
|
|
|
|
|
|
|
|
|
|
|
|
EditContext() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
attachedElements
|
|
|
|
|
|
|
|
|
|
|
|
|
characterBounds
|
|
|
|
|
|
|
|
|
|
|
|
|
characterBoundsRangeStart
|
|
|
|
|
|
|
|
|
|
|
|
|
characterboundsupdate event
|
|
|
|
|
|
|
|
|
|
|
|
|
compositionend event
|
|
|
|
|
|
|
|
|
|
|
|
|
compositionstart event
|
|
|
|
|
|
|
|
|
|
|
|
|
selectionEnd
|
|
|
|
|
|
|
|
|
|
|
|
|
selectionStart
|
|
|
|
|
|
|
|
|
|
|
|
|
text
|
|
|
|
|
|
|
|
|
|
|
|
|
textformatupdate event
|
|
|
|
|
|
|
|
|
|
|
|
|
textupdate event
|
|
|
|
|
|
|
|
|
|
|
|
|
updateCharacterBounds
|
|
|
|
|
|
|
|
|
|
|
|
|
updateControlBounds
|
|
|
|
|
|
|
|
|
|
|
|
|
updateSelection
|
|
|
|
|
|
|
|
|
|
|
|
|
updateSelectionBounds
|
|
|
|
|
|
|
|
|
|
|
|
|
updateText
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.