@ckeditor/ckeditor5-engine 40.0.0 → 40.2.0

package/src/view/editableelement.d.ts

@@ -1,62 +1,62 @@
-/**
- * @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/editableelement
- */
-import ContainerElement from './containerelement';
-import type { ElementAttributes } from './element';
-import type Document from './document';
-import type Node from './node';
-declare const EditableElement_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ContainerElement, import("@ckeditor/ckeditor5-utils").Observable>;
-/**
- * Editable element which can be a {@link module:engine/view/rooteditableelement~RootEditableElement root}
- * or nested editable area in the editor.
- *
- * Editable is automatically read-only when its {@link module:engine/view/document~Document Document} is read-only.
- *
- * The constructor of this class shouldn't be used directly. To create new `EditableElement` use the
- * {@link module:engine/view/downcastwriter~DowncastWriter#createEditableElement `downcastWriter#createEditableElement()`} method.
- */
-export default class EditableElement extends EditableElement_base {
-    /**
-     * Whether the editable is in read-write or read-only mode.
-     *
-     * @observable
-     */
-    isReadOnly: boolean;
-    /**
-     * Whether the editable is focused.
-     *
-     * This property updates when {@link module:engine/view/document~Document#isFocused document.isFocused} or view
-     * selection is changed.
-     *
-     * @readonly
-     * @observable
-     */
-    isFocused: boolean;
-    /**
-     * Placeholder of editable element.
-     *
-     * ```ts
-     * editor.editing.view.document.getRoot( 'main' ).placeholder = 'New placeholder';
-     * ```
-     *
-     * @observable
-     */
-    placeholder?: string;
-    /**
-     * Creates an editable element.
-     *
-     * @see module:engine/view/downcastwriter~DowncastWriter#createEditableElement
-     * @internal
-     * @param document The document instance to which this element belongs.
-     * @param name Node name.
-     * @param attrs Collection of attributes.
-     * @param children A list of nodes to be inserted into created element.
-     */
-    constructor(document: Document, name: string, attributes?: ElementAttributes, children?: Node | Iterable<Node>);
-    destroy(): void;
-}
-export {};
+/**
+ * @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/editableelement
+ */
+import ContainerElement from './containerelement';
+import type { ElementAttributes } from './element';
+import type Document from './document';
+import type Node from './node';
+declare const EditableElement_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ContainerElement, import("@ckeditor/ckeditor5-utils").Observable>;
+/**
+ * Editable element which can be a {@link module:engine/view/rooteditableelement~RootEditableElement root}
+ * or nested editable area in the editor.
+ *
+ * Editable is automatically read-only when its {@link module:engine/view/document~Document Document} is read-only.
+ *
+ * The constructor of this class shouldn't be used directly. To create new `EditableElement` use the
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createEditableElement `downcastWriter#createEditableElement()`} method.
+ */
+export default class EditableElement extends EditableElement_base {
+    /**
+     * Whether the editable is in read-write or read-only mode.
+     *
+     * @observable
+     */
+    isReadOnly: boolean;
+    /**
+     * Whether the editable is focused.
+     *
+     * This property updates when {@link module:engine/view/document~Document#isFocused document.isFocused} or view
+     * selection is changed.
+     *
+     * @readonly
+     * @observable
+     */
+    isFocused: boolean;
+    /**
+     * Placeholder of editable element.
+     *
+     * ```ts
+     * editor.editing.view.document.getRoot( 'main' ).placeholder = 'New placeholder';
+     * ```
+     *
+     * @observable
+     */
+    placeholder?: string;
+    /**
+     * Creates an editable element.
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createEditableElement
+     * @internal
+     * @param document The document instance to which this element belongs.
+     * @param name Node name.
+     * @param attrs Collection of attributes.
+     * @param children A list of nodes to be inserted into created element.
+     */
+    constructor(document: Document, name: string, attributes?: ElementAttributes, children?: Node | Iterable<Node>);
+    destroy(): void;
+}
+export {};

package/src/view/editableelement.js

@@ -1,62 +1,62 @@
-/**
- * @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/editableelement
- */
-import ContainerElement from './containerelement';
-import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * Editable element which can be a {@link module:engine/view/rooteditableelement~RootEditableElement root}
- * or nested editable area in the editor.
- *
- * Editable is automatically read-only when its {@link module:engine/view/document~Document Document} is read-only.
- *
- * The constructor of this class shouldn't be used directly. To create new `EditableElement` use the
- * {@link module:engine/view/downcastwriter~DowncastWriter#createEditableElement `downcastWriter#createEditableElement()`} method.
- */
-export default class EditableElement extends ObservableMixin(ContainerElement) {
-    /**
-     * Creates an editable element.
-     *
-     * @see module:engine/view/downcastwriter~DowncastWriter#createEditableElement
-     * @internal
-     * @param document The document instance to which this element belongs.
-     * @param name Node name.
-     * @param attrs Collection of attributes.
-     * @param children A list of nodes to be inserted into created element.
-     */
-    constructor(document, name, attributes, children) {
-        super(document, name, attributes, children);
-        this.set('isReadOnly', false);
-        this.set('isFocused', false);
-        this.set('placeholder', undefined);
-        this.bind('isReadOnly').to(document);
-        this.bind('isFocused').to(document, 'isFocused', isFocused => isFocused && document.selection.editableElement == this);
-        // Update focus state based on selection changes.
-        this.listenTo(document.selection, 'change', () => {
-            this.isFocused = document.isFocused && document.selection.editableElement == this;
-        });
-    }
-    destroy() {
-        this.stopListening();
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-EditableElement.prototype.is = function (type, name) {
-    if (!name) {
-        return type === 'editableElement' || type === 'view:editableElement' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'containerElement' || type === 'view:containerElement' ||
-            type === 'element' || type === 'view:element' ||
-            type === 'node' || type === 'view:node';
-    }
-    else {
-        return name === this.name && (type === 'editableElement' || type === 'view:editableElement' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'containerElement' || type === 'view:containerElement' ||
-            type === 'element' || type === 'view:element');
-    }
-};
+/**
+ * @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/editableelement
+ */
+import ContainerElement from './containerelement';
+import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
+/**
+ * Editable element which can be a {@link module:engine/view/rooteditableelement~RootEditableElement root}
+ * or nested editable area in the editor.
+ *
+ * Editable is automatically read-only when its {@link module:engine/view/document~Document Document} is read-only.
+ *
+ * The constructor of this class shouldn't be used directly. To create new `EditableElement` use the
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createEditableElement `downcastWriter#createEditableElement()`} method.
+ */
+export default class EditableElement extends ObservableMixin(ContainerElement) {
+    /**
+     * Creates an editable element.
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createEditableElement
+     * @internal
+     * @param document The document instance to which this element belongs.
+     * @param name Node name.
+     * @param attrs Collection of attributes.
+     * @param children A list of nodes to be inserted into created element.
+     */
+    constructor(document, name, attributes, children) {
+        super(document, name, attributes, children);
+        this.set('isReadOnly', false);
+        this.set('isFocused', false);
+        this.set('placeholder', undefined);
+        this.bind('isReadOnly').to(document);
+        this.bind('isFocused').to(document, 'isFocused', isFocused => isFocused && document.selection.editableElement == this);
+        // Update focus state based on selection changes.
+        this.listenTo(document.selection, 'change', () => {
+            this.isFocused = document.isFocused && document.selection.editableElement == this;
+        });
+    }
+    destroy() {
+        this.stopListening();
+    }
+}
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
+EditableElement.prototype.is = function (type, name) {
+    if (!name) {
+        return type === 'editableElement' || type === 'view:editableElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'containerElement' || type === 'view:containerElement' ||
+            type === 'element' || type === 'view:element' ||
+            type === 'node' || type === 'view:node';
+    }
+    else {
+        return name === this.name && (type === 'editableElement' || type === 'view:editableElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'containerElement' || type === 'view:containerElement' ||
+            type === 'element' || type === 'view:element');
+    }
+};