@ckeditor/ckeditor5-engine 38.1.1 → 38.2.0-alpha.1

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

@@ -1,89 +1,89 @@
-/**
- * @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/mouseobserver
- */
-import DomEventObserver from './domeventobserver';
-import type DomEventData from './domeventdata';
-/**
- * Mouse events observer.
- *
- * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
- */
-export default class MouseObserver extends DomEventObserver<'mousedown' | 'mouseup' | 'mouseover' | 'mouseout'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: readonly ["mousedown", "mouseup", "mouseover", "mouseout"];
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: MouseEvent): void;
-}
-/**
- * Fired when the mouse button is pressed down on one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
- *
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:engine/view/observer/mouseobserver~MouseObserver
- * @eventName module:engine/view/document~Document#mousedown
- * @param data The event data.
- */
-export type ViewDocumentMouseDownEvent = {
-    name: 'mousedown';
-    args: [data: DomEventData<MouseEvent>];
-};
-/**
- * Fired when the mouse button is released over one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
- *
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:engine/view/observer/mouseobserver~MouseObserver
- * @eventName module:engine/view/document~Document#mouseup
- * @param  data The event data.
- */
-export type ViewDocumentMouseUpEvent = {
-    name: 'mouseup';
-    args: [data: DomEventData<MouseEvent>];
-};
-/**
- * Fired when the mouse is over one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
- *
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:engine/view/observer/mouseobserver~MouseObserver
- * @eventName module:engine/view/document~Document#mouseover
- * @param  data The event data.
- */
-export type ViewDocumentMouseOverEvent = {
-    name: 'mouseover';
-    args: [data: DomEventData<MouseEvent>];
-};
-/**
- * Fired when the mouse is moved out of the one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
- *
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:engine/view/observer/mouseobserver~MouseObserver
- * @eventName module:engine/view/document~Document#mouseout
- * @param  data The event data.
- */
-export type ViewDocumentMouseOutEvent = {
-    name: 'mouseout';
-    args: [data: DomEventData<MouseEvent>];
-};
+/**
+ * @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/mouseobserver
+ */
+import DomEventObserver from './domeventobserver.js';
+import type DomEventData from './domeventdata.js';
+/**
+ * Mouse events observer.
+ *
+ * Note that this observer is not available by default. To make it available it needs to be added to
+ * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
+ */
+export default class MouseObserver extends DomEventObserver<'mousedown' | 'mouseup' | 'mouseover' | 'mouseout'> {
+    /**
+     * @inheritDoc
+     */
+    readonly domEventType: readonly ["mousedown", "mouseup", "mouseover", "mouseout"];
+    /**
+     * @inheritDoc
+     */
+    onDomEvent(domEvent: MouseEvent): void;
+}
+/**
+ * Fired when the mouse button is pressed down on one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
+ *
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
+ *
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
+ * @eventName module:engine/view/document~Document#mousedown
+ * @param data The event data.
+ */
+export type ViewDocumentMouseDownEvent = {
+    name: 'mousedown';
+    args: [data: DomEventData<MouseEvent>];
+};
+/**
+ * Fired when the mouse button is released over one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
+ *
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
+ *
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
+ * @eventName module:engine/view/document~Document#mouseup
+ * @param  data The event data.
+ */
+export type ViewDocumentMouseUpEvent = {
+    name: 'mouseup';
+    args: [data: DomEventData<MouseEvent>];
+};
+/**
+ * Fired when the mouse is over one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
+ *
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
+ *
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
+ * @eventName module:engine/view/document~Document#mouseover
+ * @param  data The event data.
+ */
+export type ViewDocumentMouseOverEvent = {
+    name: 'mouseover';
+    args: [data: DomEventData<MouseEvent>];
+};
+/**
+ * Fired when the mouse is moved out of the one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
+ *
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
+ *
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
+ * @eventName module:engine/view/document~Document#mouseout
+ * @param  data The event data.
+ */
+export type ViewDocumentMouseOutEvent = {
+    name: 'mouseout';
+    args: [data: DomEventData<MouseEvent>];
+};

package/src/view/observer/mouseobserver.js

@@ -1,29 +1,29 @@
-/**
- * @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/mouseobserver
- */
-import DomEventObserver from './domeventobserver';
-/**
- * Mouse events observer.
- *
- * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
- */
-export default class MouseObserver extends DomEventObserver {
-    constructor() {
-        super(...arguments);
-        /**
-         * @inheritDoc
-         */
-        this.domEventType = ['mousedown', 'mouseup', 'mouseover', 'mouseout'];
-    }
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent) {
-        this.fire(domEvent.type, domEvent);
-    }
-}
+/**
+ * @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/mouseobserver
+ */
+import DomEventObserver from './domeventobserver.js';
+/**
+ * Mouse events observer.
+ *
+ * Note that this observer is not available by default. To make it available it needs to be added to
+ * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
+ */
+export default class MouseObserver extends DomEventObserver {
+    constructor() {
+        super(...arguments);
+        /**
+         * @inheritDoc
+         */
+        this.domEventType = ['mousedown', 'mouseup', 'mouseover', 'mouseout'];
+    }
+    /**
+     * @inheritDoc
+     */
+    onDomEvent(domEvent) {
+        this.fire(domEvent.type, domEvent);
+    }
+}

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

@@ -1,86 +1,86 @@
-/**
- * @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/mutationobserver
- */
-import Observer from './observer';
-import type DomConverter from '../domconverter';
-import type Renderer from '../renderer';
-import type View from '../view';
-/**
- * Mutation observer's role is to watch for any DOM changes inside the editor that weren't
- * done by the editor's {@link module:engine/view/renderer~Renderer} itself and reverting these changes.
- *
- * It does this by observing all mutations in the DOM, marking related view elements as changed and calling
- * {@link module:engine/view/renderer~Renderer#render}. Because all mutated nodes are marked as
- * "to be rendered" and the {@link module:engine/view/renderer~Renderer#render `render()`} method is called,
- * all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
- *
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
- */
-export default class MutationObserver extends Observer {
-    /**
-     * Reference to the {@link module:engine/view/view~View#domConverter}.
-     */
-    readonly domConverter: DomConverter;
-    /**
-     * Reference to the {@link module:engine/view/view~View#_renderer}.
-     */
-    readonly renderer: Renderer;
-    /**
-     * Native mutation observer config.
-     */
-    private readonly _config;
-    /**
-     * Observed DOM elements.
-     */
-    private readonly _domElements;
-    /**
-     * Native mutation observer.
-     */
-    private _mutationObserver;
-    /**
-     * @inheritDoc
-     */
-    constructor(view: View);
-    /**
-     * Synchronously handles mutations and empties the queue.
-     */
-    flush(): void;
-    /**
-     * @inheritDoc
-     */
-    observe(domElement: HTMLElement): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(domElement: HTMLElement): void;
-    /**
-     * @inheritDoc
-     */
-    enable(): void;
-    /**
-     * @inheritDoc
-     */
-    disable(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Handles mutations. Mark view elements to sync and call render.
-     *
-     * @param domMutations Array of native mutations.
-     */
-    private _onMutations;
-    /**
-     * Checks if mutation was generated by the browser inserting bogus br on the end of the block element.
-     * Such mutations are generated while pressing space or performing native spellchecker correction
-     * on the end of the block element in Firefox browser.
-     *
-     * @param mutation Native mutation object.
-     */
-    private _isBogusBrMutation;
-}
+/**
+ * @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/mutationobserver
+ */
+import Observer from './observer.js';
+import type DomConverter from '../domconverter.js';
+import type Renderer from '../renderer.js';
+import type View from '../view.js';
+/**
+ * Mutation observer's role is to watch for any DOM changes inside the editor that weren't
+ * done by the editor's {@link module:engine/view/renderer~Renderer} itself and reverting these changes.
+ *
+ * It does this by observing all mutations in the DOM, marking related view elements as changed and calling
+ * {@link module:engine/view/renderer~Renderer#render}. Because all mutated nodes are marked as
+ * "to be rendered" and the {@link module:engine/view/renderer~Renderer#render `render()`} method is called,
+ * all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
+ *
+ * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
+ */
+export default class MutationObserver extends Observer {
+    /**
+     * Reference to the {@link module:engine/view/view~View#domConverter}.
+     */
+    readonly domConverter: DomConverter;
+    /**
+     * Reference to the {@link module:engine/view/view~View#_renderer}.
+     */
+    readonly renderer: Renderer;
+    /**
+     * Native mutation observer config.
+     */
+    private readonly _config;
+    /**
+     * Observed DOM elements.
+     */
+    private readonly _domElements;
+    /**
+     * Native mutation observer.
+     */
+    private _mutationObserver;
+    /**
+     * @inheritDoc
+     */
+    constructor(view: View);
+    /**
+     * Synchronously handles mutations and empties the queue.
+     */
+    flush(): void;
+    /**
+     * @inheritDoc
+     */
+    observe(domElement: HTMLElement): void;
+    /**
+     * @inheritDoc
+     */
+    stopObserving(domElement: HTMLElement): void;
+    /**
+     * @inheritDoc
+     */
+    enable(): void;
+    /**
+     * @inheritDoc
+     */
+    disable(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Handles mutations. Mark view elements to sync and call render.
+     *
+     * @param domMutations Array of native mutations.
+     */
+    private _onMutations;
+    /**
+     * Checks if mutation was generated by the browser inserting bogus br on the end of the block element.
+     * Such mutations are generated while pressing space or performing native spellchecker correction
+     * on the end of the block element in Firefox browser.
+     *
+     * @param mutation Native mutation object.
+     */
+    private _isBogusBrMutation;
+}