TextUpdateEvent: TextUpdateEvent() 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 TextUpdateEvent()
constructor returns a new TextUpdateEvent
object.
Syntax
new TextUpdateEvent(type)
new TextUpdateEvent(type, options)
Parameters
type
-
A string representing the type of the event. Possible values:
"textupdate"
. options
Optional-
An optional object with the following properties:
updateRangeStart
-
A number representing the offset of the first character within the editable region text that needs to be updated.
updateRangeEnd
-
A number representing the offset of the last character within the editable region text that needs to be updated.
text
-
A string representing the text that needs to be inserted or deleted.
selectionStart
-
A number representing the offset of the selection start within the editable region text.
selectionEnd
-
A number representing the offset of the selection end within the editable region text.
compositionStart
-
A number representing the offset of the start of the composition within the editable region text.
compositionEnd
-
A number representing the offset of the end of the composition within the editable region text.
Specifications
Specification |
---|
EditContext API # dom-textupdateevent-constructor |
Browser compatibility
BCD tables only load in the browser
See also
- The
TextUpdateEvent
interface it belongs to.