Trilium Frontend API
    Preparing search index...

    Class DomEventObserver<EventType, AdditionalData>Abstract

    Base class for DOM event observers. This class handles module:engine/view/observer/observer~Observer#observe adding listeners to DOM elements, module:engine/view/observer/observer~Observer#disable disabling and module:engine/view/observer/observer~Observer#enable re-enabling events. Child class needs to define module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type and module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback.

    For instance:

    class ClickObserver extends DomEventObserver<'click'> {
    	// It can also be defined as a normal property in the constructor.
    	get domEventType(): 'click' {
    		return 'click';
    	}

    	onDomEvent( domEvent: MouseEvent ): void {
    		this.fire( 'click', domEvent );
    	}
    }

    Type Parameters

    • EventType extends keyof HTMLElementEventMap

      DOM Event type name or an union of those.

    • AdditionalData extends object = object

      Additional data passed along with the event.

    Hierarchy (View Summary)

    Index
    constructor
    document useCapture usePassive view
    domEventType isEnabled
    checkShouldIgnoreEventFromTarget destroy disable enable fire observe onDomEvent stopObserving
    document: ViewDocument

    A reference to the module:engine/view/document~ViewDocument object.

    useCapture: boolean

    If set to true DOM events will be listened on the capturing phase. Default value is false.

    usePassive: boolean

    If set to true, indicates that the function specified by listener will never call preventDefault(). Default value is false.

    view: EditingView

    An instance of the view controller.

    • get domEventType(): EventType | readonly EventType[]

      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.

      Returns EventType | readonly EventType[]

    • get isEnabled(): boolean

      The state of the observer. If it is disabled, no events will be fired.

      Returns 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-events attribute. This attribute can be used inside the structures generated by module:engine/view/downcastwriter~ViewDowncastWriter#createUIElement ViewDowncastWriter#createUIElement() to ignore events fired within a UI that should be excluded from CKEditor 5's realms.

      Parameters

      • domTarget: Node

        The DOM event target to check (usually an element, sometimes a text node and potentially sometimes a document, too).

      Returns boolean

      Whether this event should be ignored by the observer.

    • Disables and destroys the observer, among others removes event listeners created by the observer.

      Returns void

    • Disables the observer. This method is called before module:engine/view/view~EditingView#forceRender rendering to prevent firing events during rendering.

      Returns void

      module:engine/view/observer/observer~Observer#enable

    • Enables the observer. This method is called when the observer is registered to the module:engine/view/view~EditingView and after module:engine/view/view~EditingView#forceRender rendering (all observers are #disable 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.

      Returns void

      module:engine/view/observer/observer~Observer#disable

    • Calls Document#fire() if observer #isEnabled is enabled.

      Parameters

      • eventType: string | EventInfo<string, unknown>

        The event type (name).

      • domEvent: Event

        The DOM event.

      • OptionaladditionalData: AdditionalData

        The additional data which should extend the module:engine/view/observer/domeventdata~ViewDocumentDomEventData event data object.

      Returns void

      module:utils/emittermixin~Emitter#fire

    • Starts observing given DOM element.

      Parameters

      Returns void

    • Callback which should be called when the DOM event occurred. Note that the callback will not be called if observer #isEnabled is not enabled.

      Parameters

      Returns void

      #domEventType

    • Stops observing given DOM element.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods