@ckeditor/ckeditor5-engine 40.0.0 → 40.2.0

package/src/view/observer/domeventobserver.js

@@ -1,79 +1,79 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/view/observer/domeventobserver
- */
-import Observer from './observer';
-import DomEventData from './domeventdata';
-/**
- * Base class for DOM event observers. This class handles
- * {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
- * {@link module:engine/view/observer/observer~Observer#disable disabling} and
- * {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
- * Child class needs to define
- * {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
- * {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
- *
- * For instance:
- *
- * ```ts
- * 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 );
- * 	}
- * }
- * ```
- *
- * @typeParam EventType DOM Event type name or an union of those.
- * @typeParam AdditionalData Additional data passed along with the event.
- */
-export default class DomEventObserver extends Observer {
-    constructor() {
-        super(...arguments);
-        /**
-         * If set to `true` DOM events will be listened on the capturing phase.
-         * Default value is `false`.
-         */
-        this.useCapture = false;
-    }
-    /**
-     * @inheritDoc
-     */
-    observe(domElement) {
-        const types = typeof this.domEventType == 'string' ? [this.domEventType] : this.domEventType;
-        types.forEach(type => {
-            this.listenTo(domElement, type, (eventInfo, domEvent) => {
-                if (this.isEnabled && !this.checkShouldIgnoreEventFromTarget(domEvent.target)) {
-                    this.onDomEvent(domEvent);
-                }
-            }, { useCapture: this.useCapture });
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    stopObserving(domElement) {
-        this.stopListening(domElement);
-    }
-    /**
-     * Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
-     *
-     * @see module:utils/emittermixin~Emitter#fire
-     * @param eventType The event type (name).
-     * @param domEvent The DOM event.
-     * @param additionalData The additional data which should extend the
-     * {@link module:engine/view/observer/domeventdata~DomEventData event data} object.
-     */
-    fire(eventType, domEvent, additionalData) {
-        if (this.isEnabled) {
-            this.document.fire(eventType, new DomEventData(this.view, domEvent, additionalData));
-        }
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/view/observer/domeventobserver
+ */
+import Observer from './observer';
+import DomEventData from './domeventdata';
+/**
+ * Base class for DOM event observers. This class handles
+ * {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
+ * {@link module:engine/view/observer/observer~Observer#disable disabling} and
+ * {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
+ * Child class needs to define
+ * {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
+ * {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
+ *
+ * For instance:
+ *
+ * ```ts
+ * 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 );
+ * 	}
+ * }
+ * ```
+ *
+ * @typeParam EventType DOM Event type name or an union of those.
+ * @typeParam AdditionalData Additional data passed along with the event.
+ */
+export default class DomEventObserver extends Observer {
+    constructor() {
+        super(...arguments);
+        /**
+         * If set to `true` DOM events will be listened on the capturing phase.
+         * Default value is `false`.
+         */
+        this.useCapture = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    observe(domElement) {
+        const types = typeof this.domEventType == 'string' ? [this.domEventType] : this.domEventType;
+        types.forEach(type => {
+            this.listenTo(domElement, type, (eventInfo, domEvent) => {
+                if (this.isEnabled && !this.checkShouldIgnoreEventFromTarget(domEvent.target)) {
+                    this.onDomEvent(domEvent);
+                }
+            }, { useCapture: this.useCapture });
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    stopObserving(domElement) {
+        this.stopListening(domElement);
+    }
+    /**
+     * Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
+     *
+     * @see module:utils/emittermixin~Emitter#fire
+     * @param eventType The event type (name).
+     * @param domEvent The DOM event.
+     * @param additionalData The additional data which should extend the
+     * {@link module:engine/view/observer/domeventdata~DomEventData event data} object.
+     */
+    fire(eventType, domEvent, additionalData) {
+        if (this.isEnabled) {
+            this.document.fire(eventType, new DomEventData(this.view, domEvent, additionalData));
+        }
+    }
+}

package/src/view/observer/fakeselectionobserver.d.ts

@@ -1,47 +1,47 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/view/observer/fakeselectionobserver
- */
-import Observer from './observer';
-import type View from '../view';
-/**
- * Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
- * on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
- * if arrow keys are pressed.
- * Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
- * {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
- */
-export default class FakeSelectionObserver extends Observer {
-    /**
-     * Fires debounced event `selectionChangeDone`. It uses `lodash#debounce` method to delay function call.
-     */
-    private readonly _fireSelectionChangeDoneDebounced;
-    /**
-     * Creates new FakeSelectionObserver instance.
-     */
-    constructor(view: View);
-    /**
-     * @inheritDoc
-     */
-    observe(): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
-     * collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
-     *
-     * This method fires {@link module:engine/view/document~Document#event:selectionChange} and
-     * {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
-     * {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
-     */
-    private _handleSelectionMove;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/view/observer/fakeselectionobserver
+ */
+import Observer from './observer';
+import type View from '../view';
+/**
+ * Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
+ * on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
+ * if arrow keys are pressed.
+ * Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
+ * {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
+ */
+export default class FakeSelectionObserver extends Observer {
+    /**
+     * Fires debounced event `selectionChangeDone`. It uses `lodash#debounce` method to delay function call.
+     */
+    private readonly _fireSelectionChangeDoneDebounced;
+    /**
+     * Creates new FakeSelectionObserver instance.
+     */
+    constructor(view: View);
+    /**
+     * @inheritDoc
+     */
+    observe(): void;
+    /**
+     * @inheritDoc
+     */
+    stopObserving(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
+     * collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
+     *
+     * This method fires {@link module:engine/view/document~Document#event:selectionChange} and
+     * {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
+     * {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
+     */
+    private _handleSelectionMove;
+}

package/src/view/observer/fakeselectionobserver.js

@@ -1,91 +1,91 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/view/observer/fakeselectionobserver
- */
-import Observer from './observer';
-import ViewSelection from '../selection';
-import { keyCodes } from '@ckeditor/ckeditor5-utils';
-import { debounce } from 'lodash-es';
-/**
- * Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
- * on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
- * if arrow keys are pressed.
- * Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
- * {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
- */
-export default class FakeSelectionObserver extends Observer {
-    /**
-     * Creates new FakeSelectionObserver instance.
-     */
-    constructor(view) {
-        super(view);
-        this._fireSelectionChangeDoneDebounced = debounce(data => {
-            this.document.fire('selectionChangeDone', data);
-        }, 200);
-    }
-    /**
-     * @inheritDoc
-     */
-    observe() {
-        const document = this.document;
-        document.on('arrowKey', (eventInfo, data) => {
-            const selection = document.selection;
-            if (selection.isFake && this.isEnabled) {
-                // Prevents default key down handling - no selection change will occur.
-                data.preventDefault();
-            }
-        }, { context: '$capture' });
-        document.on('arrowKey', (eventInfo, data) => {
-            const selection = document.selection;
-            if (selection.isFake && this.isEnabled) {
-                this._handleSelectionMove(data.keyCode);
-            }
-        }, { priority: 'lowest' });
-    }
-    /**
-     * @inheritDoc
-     */
-    stopObserving() { }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this._fireSelectionChangeDoneDebounced.cancel();
-    }
-    /**
-     * Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
-     * collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
-     *
-     * This method fires {@link module:engine/view/document~Document#event:selectionChange} and
-     * {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
-     * {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
-     */
-    _handleSelectionMove(keyCode) {
-        const selection = this.document.selection;
-        const newSelection = new ViewSelection(selection.getRanges(), { backward: selection.isBackward, fake: false });
-        // Left or up arrow pressed - move selection to start.
-        if (keyCode == keyCodes.arrowleft || keyCode == keyCodes.arrowup) {
-            newSelection.setTo(newSelection.getFirstPosition());
-        }
-        // Right or down arrow pressed - move selection to end.
-        if (keyCode == keyCodes.arrowright || keyCode == keyCodes.arrowdown) {
-            newSelection.setTo(newSelection.getLastPosition());
-        }
-        const data = {
-            oldSelection: selection,
-            newSelection,
-            domSelection: null
-        };
-        // Fire dummy selection change event.
-        this.document.fire('selectionChange', data);
-        // Call` #_fireSelectionChangeDoneDebounced` every time when `selectionChange` event is fired.
-        // This function is debounced what means that `selectionChangeDone` event will be fired only when
-        // defined int the function time will elapse since the last time the function was called.
-        // So `selectionChangeDone` will be fired when selection will stop changing.
-        this._fireSelectionChangeDoneDebounced(data);
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/view/observer/fakeselectionobserver
+ */
+import Observer from './observer';
+import ViewSelection from '../selection';
+import { keyCodes } from '@ckeditor/ckeditor5-utils';
+import { debounce } from 'lodash-es';
+/**
+ * Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
+ * on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
+ * if arrow keys are pressed.
+ * Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
+ * {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
+ */
+export default class FakeSelectionObserver extends Observer {
+    /**
+     * Creates new FakeSelectionObserver instance.
+     */
+    constructor(view) {
+        super(view);
+        this._fireSelectionChangeDoneDebounced = debounce(data => {
+            this.document.fire('selectionChangeDone', data);
+        }, 200);
+    }
+    /**
+     * @inheritDoc
+     */
+    observe() {
+        const document = this.document;
+        document.on('arrowKey', (eventInfo, data) => {
+            const selection = document.selection;
+            if (selection.isFake && this.isEnabled) {
+                // Prevents default key down handling - no selection change will occur.
+                data.preventDefault();
+            }
+        }, { context: '$capture' });
+        document.on('arrowKey', (eventInfo, data) => {
+            const selection = document.selection;
+            if (selection.isFake && this.isEnabled) {
+                this._handleSelectionMove(data.keyCode);
+            }
+        }, { priority: 'lowest' });
+    }
+    /**
+     * @inheritDoc
+     */
+    stopObserving() { }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this._fireSelectionChangeDoneDebounced.cancel();
+    }
+    /**
+     * Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
+     * collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
+     *
+     * This method fires {@link module:engine/view/document~Document#event:selectionChange} and
+     * {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
+     * {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
+     */
+    _handleSelectionMove(keyCode) {
+        const selection = this.document.selection;
+        const newSelection = new ViewSelection(selection.getRanges(), { backward: selection.isBackward, fake: false });
+        // Left or up arrow pressed - move selection to start.
+        if (keyCode == keyCodes.arrowleft || keyCode == keyCodes.arrowup) {
+            newSelection.setTo(newSelection.getFirstPosition());
+        }
+        // Right or down arrow pressed - move selection to end.
+        if (keyCode == keyCodes.arrowright || keyCode == keyCodes.arrowdown) {
+            newSelection.setTo(newSelection.getLastPosition());
+        }
+        const data = {
+            oldSelection: selection,
+            newSelection,
+            domSelection: null
+        };
+        // Fire dummy selection change event.
+        this.document.fire('selectionChange', data);
+        // Call` #_fireSelectionChangeDoneDebounced` every time when `selectionChange` event is fired.
+        // This function is debounced what means that `selectionChangeDone` event will be fired only when
+        // defined int the function time will elapse since the last time the function was called.
+        // So `selectionChangeDone` will be fired when selection will stop changing.
+        this._fireSelectionChangeDoneDebounced(data);
+    }
+}

package/src/view/observer/focusobserver.d.ts

@@ -1,82 +1,82 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/view/observer/focusobserver
- */
-import DomEventObserver from './domeventobserver';
-import type DomEventData from './domeventdata';
-import type View from '../view';
-/**
- * {@link module:engine/view/document~Document#event:focus Focus}
- * and {@link module:engine/view/document~Document#event:blur blur} events observer.
- * Focus observer handle also {@link module:engine/view/rooteditableelement~RootEditableElement#isFocused isFocused} property of the
- * {@link module:engine/view/rooteditableelement~RootEditableElement root elements}.
- *
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
- */
-export default class FocusObserver extends DomEventObserver<'focus' | 'blur'> {
-    /**
-     * Identifier of the timeout currently used by focus listener to delay rendering execution.
-     */
-    private _renderTimeoutId;
-    /**
-     * Set to `true` if the document is in the process of setting the focus.
-     *
-     * The flag is used to indicate that setting the focus is in progress.
-     */
-    private _isFocusChanging;
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: readonly ["focus", "blur"];
-    /**
-     * @inheritDoc
-     */
-    constructor(view: View);
-    /**
-     * Finishes setting the document focus state.
-     */
-    flush(): void;
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: FocusEvent): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}
-/**
- * Fired when one of the editables gets focus.
- *
- * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
- *
- * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
- * {@link module:engine/view/view~View} this event is available by default.
- *
- * @see module:engine/view/observer/focusobserver~FocusObserver
- * @eventName module:engine/view/document~Document#focus
- * @param data Event data.
- */
-export type ViewDocumentFocusEvent = {
-    name: 'focus';
-    args: [data: DomEventData<FocusEvent>];
-};
-/**
- * Fired when one of the editables loses focus.
- *
- * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
- *
- * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
- * {@link module:engine/view/view~View} this event is available by default.
- *
- * @see module:engine/view/observer/focusobserver~FocusObserver
- * @eventName module:engine/view/document~Document#blur
- * @param data Event data.
- */
-export type ViewDocumentBlurEvent = {
-    name: 'blur';
-    args: [data: DomEventData<FocusEvent>];
-};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/view/observer/focusobserver
+ */
+import DomEventObserver from './domeventobserver';
+import type DomEventData from './domeventdata';
+import type View from '../view';
+/**
+ * {@link module:engine/view/document~Document#event:focus Focus}
+ * and {@link module:engine/view/document~Document#event:blur blur} events observer.
+ * Focus observer handle also {@link module:engine/view/rooteditableelement~RootEditableElement#isFocused isFocused} property of the
+ * {@link module:engine/view/rooteditableelement~RootEditableElement root elements}.
+ *
+ * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
+ */
+export default class FocusObserver extends DomEventObserver<'focus' | 'blur'> {
+    /**
+     * Identifier of the timeout currently used by focus listener to delay rendering execution.
+     */
+    private _renderTimeoutId;
+    /**
+     * Set to `true` if the document is in the process of setting the focus.
+     *
+     * The flag is used to indicate that setting the focus is in progress.
+     */
+    private _isFocusChanging;
+    /**
+     * @inheritDoc
+     */
+    readonly domEventType: readonly ["focus", "blur"];
+    /**
+     * @inheritDoc
+     */
+    constructor(view: View);
+    /**
+     * Finishes setting the document focus state.
+     */
+    flush(): void;
+    /**
+     * @inheritDoc
+     */
+    onDomEvent(domEvent: FocusEvent): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}
+/**
+ * Fired when one of the editables gets focus.
+ *
+ * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
+ *
+ * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
+ * {@link module:engine/view/view~View} this event is available by default.
+ *
+ * @see module:engine/view/observer/focusobserver~FocusObserver
+ * @eventName module:engine/view/document~Document#focus
+ * @param data Event data.
+ */
+export type ViewDocumentFocusEvent = {
+    name: 'focus';
+    args: [data: DomEventData<FocusEvent>];
+};
+/**
+ * Fired when one of the editables loses focus.
+ *
+ * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
+ *
+ * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
+ * {@link module:engine/view/view~View} this event is available by default.
+ *
+ * @see module:engine/view/observer/focusobserver~FocusObserver
+ * @eventName module:engine/view/document~Document#blur
+ * @param data Event data.
+ */
+export type ViewDocumentBlurEvent = {
+    name: 'blur';
+    args: [data: DomEventData<FocusEvent>];
+};