CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

InputEventData (engine/view/observer)

@ckeditor/ckeditor5-engine/src/view/observer/inputobserver

interface
See source

The value of the ViewDocumentInputEvent event.

Filtering

Properties

  • readonly

    data : null | string

    See source

    A unified text data passed along with the input event. Depending on:

    text data is sometimes passed in the data and sometimes in the dataTransfer property.

    • If InputEvent#data was set, this property reflects its value.
    • If InputEvent#data is unavailable, this property contains the 'text/plain' data from dataTransfer.
    • If the event (input type) provides no data whatsoever, this property is null.

  • readonly

    dataTransfer : DataTransfer

    See source

    The data transfer instance of the input event. Corresponds to native InputEvent#dataTransfer.

    The value is null when no dataTransfer was passed along with the input event.

  • readonly inherited

    document : Document

    See source

    The instance of the document.

  • readonly inherited

    domEvent : InputEvent

    See source

    The DOM event.

  • readonly inherited

    domTarget : HTMLElement

    See source

    The DOM target.

  • readonly

    inputType : string

    See source

    The type of the input event (e.g. "insertText" or "deleteWordBackward"). Corresponds to native InputEvent#inputType.

  • readonly

    isComposing : boolean

    See source

    A flag indicating that the beforeinput event was fired during composition.

    Corresponds to the event-compositionstart, event-compositionupdate, and event-compositionend trio.

  • readonly inherited

    target : Element

    See source

    The tree view element representing the target.

  • readonly

    targetRanges : Array<Range>

    See source

    Editing view ranges corresponding to DOM ranges provided by the web browser (as returned by InputEvent#getTargetRanges()).

  • readonly inherited

    view : View

    See source

    Instance of the view controller.

Methods

  • inherited

    preventDefault() → void

    See source

    Prevents the native's event default action.

    Returns

    void

  • inherited

    stopPropagation() → void

    See source

    Stops native event propagation.

    Returns

    void