Observer for events connected with pressing keyboard keys.
Note that this observer is attached by the
View and is available by default.
A reference to the
domEventType : String | Array.<String>
Type of the DOM event the observer should listen to. Array of types can be defined if the observer should listen to multiple DOM events.
isEnabled : Boolean
The state of the observer. If it is disabled, no events will be fired.
useCapture : Boolean
If set to
trueDOM events will be listened on the capturing phase. Default value is
An instance of the view controller.
checkShouldIgnoreEventFromTarget( domTarget ) → Boolean
Checks whether a given DOM event should be ignored (should not be turned into a synthetic view document event).
Currently, an event will be ignored only if its target or any of its ancestors has the
data-cke-ignore-eventsattribute. This attribute can be used inside the structures generated by
DowncastWriter#createUIElement()to ignore events fired within a UI that should be excluded from CKEditor 5's realms.
domTarget : Node
The DOM event target to check (usually an element, sometimes a text node and potentially sometimes a document, too).
Whether this event should be ignored by the observer.
Disables and destroys the observer, among others removes event listeners created by the observer.
Disables the observer. This method is called before rendering to prevent firing events during rendering.
Enables the observer. This method is called when the observer is registered to the
Viewand after rendering (all observers are disabled before rendering).
A typical use case for disabling observers is that mutation observers need to be disabled for the rendering. However, a child class may not need to be disabled, so it can implement an empty method.
fire( eventType, domEvent, [ additionalData ] )
Document#fire()if observer is enabled.
eventType : String
The event type (name).
domEvent : Event
The DOM event.
[ additionalData ] : Object
The additional data which should extend the event data object.
observe( domElement, name )
Starts observing the given root element.
domElement : HTMLElement
name : String
The name of the root element.
Callback which should be called when the DOM event occurred. Note that the callback will not be called if observer is not enabled.
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.