@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/view/elementdefinition.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/view/emptyelement.js

@@ -2,15 +2,12 @@
  * @license Copyright (c) 2003-2022, 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/emptyelement
  */
-
 import Element from './element';
-import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
 import Node from './node';
-
+import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
 /**
  * Empty element class. It is used to represent elements that cannot contain any child nodes (for example `<img>` elements).
  *
@@ -20,97 +17,90 @@ import Node from './node';
  * @extends module:engine/view/element~Element
  */
 export default class EmptyElement extends Element {
-	/**
-	 * Creates new instance of EmptyElement.
-	 *
-	 * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed,
-	 * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden).
-	 *
-	 * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
-	 * @protected
-	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
-	 * @param {String} name Node name.
-	 * @param {Object|Iterable} [attrs] Collection of attributes.
-	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
-	 * A list of nodes to be inserted into created element.
-	 */
-	constructor( document, name, attrs, children ) {
-		super( document, name, attrs, children );
-
-		/**
-		 * Returns `null` because filler is not needed for EmptyElements.
-		 *
-		 * @method #getFillerOffset
-		 * @returns {null} Always returns null.
-		 */
-		this.getFillerOffset = getFillerOffset;
-	}
-
-	/**
-	 * Checks whether this object is of the given.
-	 *
-	 *		emptyElement.is( 'emptyElement' ); // -> true
-	 *		emptyElement.is( 'element' ); // -> true
-	 *		emptyElement.is( 'node' ); // -> true
-	 *		emptyElement.is( 'view:emptyElement' ); // -> true
-	 *		emptyElement.is( 'view:element' ); // -> true
-	 *		emptyElement.is( 'view:node' ); // -> true
-	 *
-	 *		emptyElement.is( 'model:element' ); // -> false
-	 *		emptyElement.is( 'documentFragment' ); // -> false
-	 *
-	 * Assuming that the object being checked is an empty element, you can also check its
-	 * {@link module:engine/view/emptyelement~EmptyElement#name name}:
-	 *
-	 *		emptyElement.is( 'element', 'img' ); // -> true if this is a img element
-	 *		emptyElement.is( 'emptyElement', 'img' ); // -> same as above
-	 *		text.is( 'element', 'img' ); -> false
-	 *
-	 * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
-	 *
-	 * @param {String} type Type to check.
-	 * @param {String} [name] Element name.
-	 * @returns {Boolean}
-	 */
-	is( type, name = null ) {
-		if ( !name ) {
-			return type === 'emptyElement' || type === 'view:emptyElement' ||
-				// From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-				type === 'element' || type === 'view:element' ||
-				type === 'node' || type === 'view:node';
-		} else {
-			return name === this.name && (
-				type === 'emptyElement' || type === 'view:emptyElement' ||
-				type === 'element' || type === 'view:element'
-			);
-		}
-	}
-
-	/**
-	 * Overrides {@link module:engine/view/element~Element#_insertChild} method.
-	 * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent
-	 * adding any child nodes to EmptyElement.
-	 *
-	 * @protected
-	 */
-	_insertChild( index, nodes ) {
-		if ( nodes && ( nodes instanceof Node || Array.from( nodes ).length > 0 ) ) {
-			/**
-			 * Cannot add children to {@link module:engine/view/emptyelement~EmptyElement}.
-			 *
-			 * @error view-emptyelement-cannot-add
-			 */
-			throw new CKEditorError(
-				'view-emptyelement-cannot-add',
-				[ this, nodes ]
-			);
-		}
-	}
+    /**
+     * Creates new instance of EmptyElement.
+     *
+     * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed,
+     * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden).
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
+     * @protected
+     * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
+     * @param {String} name Node name.
+     * @param {Object|Iterable} [attrs] Collection of attributes.
+     * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
+     * A list of nodes to be inserted into created element.
+     */
+    constructor(document, name, attributes, children) {
+        super(document, name, attributes, children);
+        /**
+         * Returns `null` because filler is not needed for EmptyElements.
+         *
+         * @method #getFillerOffset
+         * @returns {null} Always returns null.
+         */
+        this.getFillerOffset = getFillerOffset;
+    }
+    /**
+     * Overrides {@link module:engine/view/element~Element#_insertChild} method.
+     * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent
+     * adding any child nodes to EmptyElement.
+     *
+     * @protected
+     */
+    _insertChild(index, items) {
+        if (items && (items instanceof Node || Array.from(items).length > 0)) {
+            /**
+             * Cannot add children to {@link module:engine/view/emptyelement~EmptyElement}.
+             *
+             * @error view-emptyelement-cannot-add
+             */
+            throw new CKEditorError('view-emptyelement-cannot-add', [this, items]);
+        }
+        return 0;
+    }
 }
-
+/**
+ * Checks whether this object is of the given.
+ *
+ *		emptyElement.is( 'emptyElement' ); // -> true
+ *		emptyElement.is( 'element' ); // -> true
+ *		emptyElement.is( 'node' ); // -> true
+ *		emptyElement.is( 'view:emptyElement' ); // -> true
+ *		emptyElement.is( 'view:element' ); // -> true
+ *		emptyElement.is( 'view:node' ); // -> true
+ *
+ *		emptyElement.is( 'model:element' ); // -> false
+ *		emptyElement.is( 'documentFragment' ); // -> false
+ *
+ * Assuming that the object being checked is an empty element, you can also check its
+ * {@link module:engine/view/emptyelement~EmptyElement#name name}:
+ *
+ *		emptyElement.is( 'element', 'img' ); // -> true if this is a img element
+ *		emptyElement.is( 'emptyElement', 'img' ); // -> same as above
+ *		text.is( 'element', 'img' ); -> false
+ *
+ * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
+ *
+ * @param {String} type Type to check.
+ * @param {String} [name] Element name.
+ * @returns {Boolean}
+ */
+EmptyElement.prototype.is = function (type, name) {
+    if (!name) {
+        return type === 'emptyElement' || type === 'view:emptyElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'element' || type === 'view:element' ||
+            type === 'node' || type === 'view:node';
+    }
+    else {
+        return name === this.name && (type === 'emptyElement' || type === 'view:emptyElement' ||
+            type === 'element' || type === 'view:element');
+    }
+};
 // Returns `null` because block filler is not needed for EmptyElements.
 //
 // @returns {null}
 function getFillerOffset() {
-	return null;
+    return null;
 }

package/src/view/filler.js

@@ -2,10 +2,8 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
 import isText from '@ckeditor/ckeditor5-utils/src/dom/istext';
-
 /**
  * Set of utilities related to handling block and inline fillers.
  *
@@ -34,7 +32,6 @@ import isText from '@ckeditor/ckeditor5-utils/src/dom/istext';
  *
  * @module engine/view/filler
  */
-
 /**
  * Non-breaking space filler creator. This function creates the ` ` text node.
  * It defines how the filler is created.
@@ -43,8 +40,7 @@ import isText from '@ckeditor/ckeditor5-utils/src/dom/istext';
  * @see module:engine/view/filler~BR_FILLER
  * @function
  */
-export const NBSP_FILLER = domDocument => domDocument.createTextNode( '\u00A0' );
-
+export const NBSP_FILLER = (domDocument) => domDocument.createTextNode('\u00A0');
 /**
  * Marked non-breaking space filler creator. This function creates the `<span data-cke-filler="true">&nbsp;</span>` element.
  * It defines how the filler is created.
@@ -53,14 +49,12 @@ export const NBSP_FILLER = domDocument => domDocument.createTextNode( '\u00A0' )
  * @see module:engine/view/filler~BR_FILLER
  * @function
  */
-export const MARKED_NBSP_FILLER = domDocument => {
-	const span = domDocument.createElement( 'span' );
-	span.dataset.ckeFiller = true;
-	span.innerText = '\u00A0';
-
-	return span;
+export const MARKED_NBSP_FILLER = (domDocument) => {
+    const span = domDocument.createElement('span');
+    span.dataset.ckeFiller = 'true';
+    span.innerText = '\u00A0';
+    return span;
 };
-
 /**
  * `<br>` filler creator. This function creates the `<br data-cke-filler="true">` element.
  * It defines how the filler is created.
@@ -69,25 +63,21 @@ export const MARKED_NBSP_FILLER = domDocument => {
  * @see module:engine/view/filler~MARKED_NBSP_FILLER
  * @function
  */
-export const BR_FILLER = domDocument => {
-	const fillerBr = domDocument.createElement( 'br' );
-	fillerBr.dataset.ckeFiller = true;
-
-	return fillerBr;
+export const BR_FILLER = (domDocument) => {
+    const fillerBr = domDocument.createElement('br');
+    fillerBr.dataset.ckeFiller = 'true';
+    return fillerBr;
 };
-
 /**
  * Length of the {@link module:engine/view/filler~INLINE_FILLER INLINE_FILLER}.
  */
 export const INLINE_FILLER_LENGTH = 7;
-
 /**
  * Inline filler which is a sequence of the word joiners.
  *
  * @type {String}
  */
-export const INLINE_FILLER = '\u2060'.repeat( INLINE_FILLER_LENGTH );
-
+export const INLINE_FILLER = '\u2060'.repeat(INLINE_FILLER_LENGTH);
 /**
  * Checks if the node is a text node which starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  *
@@ -99,10 +89,9 @@ export const INLINE_FILLER = '\u2060'.repeat( INLINE_FILLER_LENGTH );
  * @param {Node} domNode DOM node.
  * @returns {Boolean} True if the text node starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  */
-export function startsWithFiller( domNode ) {
-	return isText( domNode ) && ( domNode.data.substr( 0, INLINE_FILLER_LENGTH ) === INLINE_FILLER );
+export function startsWithFiller(domNode) {
+    return isText(domNode) && (domNode.data.substr(0, INLINE_FILLER_LENGTH) === INLINE_FILLER);
 }
-
 /**
  * Checks if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  *
@@ -112,10 +101,9 @@ export function startsWithFiller( domNode ) {
  * @param {Text} domText DOM text node.
  * @returns {Boolean} True if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  */
-export function isInlineFiller( domText ) {
-	return domText.data.length == INLINE_FILLER_LENGTH && startsWithFiller( domText );
+export function isInlineFiller(domText) {
+    return domText.data.length == INLINE_FILLER_LENGTH && startsWithFiller(domText);
 }
-
 /**
  * Get string data from the text node, removing an {@link module:engine/view/filler~INLINE_FILLER inline filler} from it,
  * if text node contains it.
@@ -126,36 +114,33 @@ export function isInlineFiller( domText ) {
  * @param {Text} domText DOM text node, possible with inline filler.
  * @returns {String} Data without filler.
  */
-export function getDataWithoutFiller( domText ) {
-	if ( startsWithFiller( domText ) ) {
-		return domText.data.slice( INLINE_FILLER_LENGTH );
-	} else {
-		return domText.data;
-	}
+export function getDataWithoutFiller(domText) {
+    if (startsWithFiller(domText)) {
+        return domText.data.slice(INLINE_FILLER_LENGTH);
+    }
+    else {
+        return domText.data;
+    }
 }
-
 /**
  * Assign key observer which move cursor from the end of the inline filler to the beginning of it when
  * the left arrow is pressed, so the filler does not break navigation.
  *
  * @param {module:engine/view/view~View} view View controller instance we should inject quirks handling on.
  */
-export function injectQuirksHandling( view ) {
-	view.document.on( 'arrowKey', jumpOverInlineFiller, { priority: 'low' } );
+export function injectQuirksHandling(view) {
+    view.document.on('arrowKey', jumpOverInlineFiller, { priority: 'low' });
 }
-
 // Move cursor from the end of the inline filler to the beginning of it when, so the filler does not break navigation.
-function jumpOverInlineFiller( evt, data ) {
-	if ( data.keyCode == keyCodes.arrowleft ) {
-		const domSelection = data.domTarget.ownerDocument.defaultView.getSelection();
-
-		if ( domSelection.rangeCount == 1 && domSelection.getRangeAt( 0 ).collapsed ) {
-			const domParent = domSelection.getRangeAt( 0 ).startContainer;
-			const domOffset = domSelection.getRangeAt( 0 ).startOffset;
-
-			if ( startsWithFiller( domParent ) && domOffset <= INLINE_FILLER_LENGTH ) {
-				domSelection.collapse( domParent, 0 );
-			}
-		}
-	}
+function jumpOverInlineFiller(evt, data) {
+    if (data.keyCode == keyCodes.arrowleft) {
+        const domSelection = data.domTarget.ownerDocument.defaultView.getSelection();
+        if (domSelection.rangeCount == 1 && domSelection.getRangeAt(0).collapsed) {
+            const domParent = domSelection.getRangeAt(0).startContainer;
+            const domOffset = domSelection.getRangeAt(0).startOffset;
+            if (startsWithFiller(domParent) && domOffset <= INLINE_FILLER_LENGTH) {
+                domSelection.collapse(domParent, 0);
+            }
+        }
+    }
 }

package/src/view/item.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};