InputEventData (engine/view/observer)
@ckeditor/ckeditor5-engine/src/view/observer/inputobserver
The value of the ViewDocumentInputEvent
event.
Filtering
Properties
-
A unified text data passed along with the input event. Depending on:
- the web browser and input events implementation (for instance Level 1 or Level 2),
- input type
text data is sometimes passed in the
data
and sometimes in thedataTransfer
property.- If
InputEvent#data
was set, this property reflects its value. - If
InputEvent#data
is unavailable, this property contains the'text/plain'
data fromdataTransfer
. - If the event (input type)
provides no data whatsoever, this property is
null
.
-
readonly
dataTransfer : DataTransfer
module:engine/view/observer/inputobserver~InputEventData#dataTransfer
The data transfer instance of the input event. Corresponds to native
InputEvent#dataTransfer
.The value is
null
when nodataTransfer
was passed along with the input event. -
readonly inherited
document : Document
module:engine/view/observer/inputobserver~InputEventData#document
The instance of the document.
-
readonly inherited
domEvent : InputEvent
module:engine/view/observer/inputobserver~InputEventData#domEvent
The DOM event.
-
readonly inherited
domTarget : HTMLElement
module:engine/view/observer/inputobserver~InputEventData#domTarget
The DOM target.
-
The type of the input event (e.g. "insertText" or "deleteWordBackward"). Corresponds to native
InputEvent#inputType
. -
A flag indicating that the
beforeinput
event was fired during composition.Corresponds to the event-compositionstart, event-compositionupdate, and event-compositionend trio.
-
The tree view element representing the target.
-
readonly
targetRanges : Array<Range>
module:engine/view/observer/inputobserver~InputEventData#targetRanges
Editing view ranges corresponding to DOM ranges provided by the web browser (as returned by
InputEvent#getTargetRanges()
). -
Instance of the view controller.
Methods
-
inherited
preventDefault() → void
module:engine/view/observer/inputobserver~InputEventData#preventDefault
-
inherited
stopPropagation() → void
module:engine/view/observer/inputobserver~InputEventData#stopPropagation
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.