@ckeditor/ckeditor5-utils 34.2.0 → 35.1.0

package/src/first.js

@@ -2,23 +2,19 @@
  * @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 utils/first
  */
-
 /**
- * Returns first item of the given `iterable`.
+ * Returns first item of the given `iterator`.
  *
- * @param {Iterable.<*>} iterable
+ * @param {Iterator.<*>} iterator
  * @returns {*}
  */
-export default function first( iterable ) {
-	const iteratorItem = iterable.next();
-
-	if ( iteratorItem.done ) {
-		return null;
-	}
-
-	return iteratorItem.value;
+export default function first(iterator) {
+    const iteratorItem = iterator.next();
+    if (iteratorItem.done) {
+        return null;
+    }
+    return iteratorItem.value;
 }

package/src/focustracker.js

@@ -2,25 +2,21 @@
  * @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
  */
-
 /* global setTimeout, clearTimeout */
-
+/* eslint-disable new-cap */
 /**
  * @module utils/focustracker
  */
-
 import DomEmitterMixin from './dom/emittermixin';
-import ObservableMixin from './observablemixin';
+import { Observable } from './observablemixin';
 import CKEditorError from './ckeditorerror';
-import mix from './mix';
-
 /**
- * Allows observing a group of `HTMLElement`s whether at least one of them is focused.
+ * Allows observing a group of `Element`s whether at least one of them is focused.
  *
  * Used by the {@link module:core/editor/editor~Editor} in order to track whether the focus is still within the application,
  * or were used outside of its UI.
  *
- * **Note** `focus` and `blur` listeners use event capturing, so it is only needed to register wrapper `HTMLElement`
+ * **Note** `focus` and `blur` listeners use event capturing, so it is only needed to register wrapper `Element`
  * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
  * (have e.g. `tabindex="-1"`).
  *
@@ -29,129 +25,77 @@ import mix from './mix';
  * @mixes module:utils/dom/emittermixin~EmitterMixin
  * @mixes module:utils/observablemixin~ObservableMixin
  */
-export default class FocusTracker {
-	constructor() {
-		/**
-		 * True when one of the registered elements is focused.
-		 *
-		 * @readonly
-		 * @observable
-		 * @member {Boolean} #isFocused
-		 */
-		this.set( 'isFocused', false );
-
-		/**
-		 * The currently focused element.
-		 *
-		 * While {@link #isFocused `isFocused`} remains `true`, the focus can
-		 * move between different UI elements. This property tracks those
-		 * elements and tells which one is currently focused.
-		 *
-		 * @readonly
-		 * @observable
-		 * @member {HTMLElement|null} #focusedElement
-		 */
-		this.set( 'focusedElement', null );
-
-		/**
-		 * List of registered elements.
-		 *
-		 * @private
-		 * @member {Set.<HTMLElement>}
-		 */
-		this._elements = new Set();
-
-		/**
-		 * Event loop timeout.
-		 *
-		 * @private
-		 * @member {Number}
-		 */
-		this._nextEventLoopTimeout = null;
-	}
-
-	/**
-	 * Starts tracking the specified element.
-	 *
-	 * @param {HTMLElement} element
-	 */
-	add( element ) {
-		if ( this._elements.has( element ) ) {
-			/**
-			 * This element is already tracked by {@link module:utils/focustracker~FocusTracker}.
-			 *
-			 * @error focustracker-add-element-already-exist
-			 */
-			throw new CKEditorError( 'focustracker-add-element-already-exist', this );
-		}
-
-		this.listenTo( element, 'focus', () => this._focus( element ), { useCapture: true } );
-		this.listenTo( element, 'blur', () => this._blur(), { useCapture: true } );
-		this._elements.add( element );
-	}
-
-	/**
-	 * Stops tracking the specified element and stops listening on this element.
-	 *
-	 * @param {HTMLElement} element
-	 */
-	remove( element ) {
-		if ( element === this.focusedElement ) {
-			this._blur( element );
-		}
-
-		if ( this._elements.has( element ) ) {
-			this.stopListening( element );
-			this._elements.delete( element );
-		}
-	}
-
-	/**
-	 * Destroys the focus tracker by:
-	 * - Disabling all event listeners attached to tracked elements.
-	 * - Removing all tracked elements that were previously added.
-	 */
-	destroy() {
-		this.stopListening();
-	}
-
-	/**
-	 * Stores currently focused element and set {#isFocused} as `true`.
-	 *
-	 * @private
-	 * @param {HTMLElement} element Element which has been focused.
-	 */
-	_focus( element ) {
-		clearTimeout( this._nextEventLoopTimeout );
-
-		this.focusedElement = element;
-		this.isFocused = true;
-	}
-
-	/**
-	 * Clears currently focused element and set {@link #isFocused} as `false`.
-	 * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
-	 *
-	 * @private
-	 * @fires blur
-	 */
-	_blur() {
-		clearTimeout( this._nextEventLoopTimeout );
-
-		this._nextEventLoopTimeout = setTimeout( () => {
-			this.focusedElement = null;
-			this.isFocused = false;
-		}, 0 );
-	}
-
-	/**
-	 * @event focus
-	 */
-
-	/**
-	 * @event blur
-	 */
+export default class FocusTracker extends DomEmitterMixin(Observable) {
+    constructor() {
+        super();
+        this.set('isFocused', false);
+        this.set('focusedElement', null);
+        this._elements = new Set();
+        this._nextEventLoopTimeout = null;
+    }
+    /**
+     * Starts tracking the specified element.
+     *
+     * @param {Element} element
+     */
+    add(element) {
+        if (this._elements.has(element)) {
+            /**
+             * This element is already tracked by {@link module:utils/focustracker~FocusTracker}.
+             *
+             * @error focustracker-add-element-already-exist
+             */
+            throw new CKEditorError('focustracker-add-element-already-exist', this);
+        }
+        this.listenTo(element, 'focus', () => this._focus(element), { useCapture: true });
+        this.listenTo(element, 'blur', () => this._blur(), { useCapture: true });
+        this._elements.add(element);
+    }
+    /**
+     * Stops tracking the specified element and stops listening on this element.
+     *
+     * @param {Element} element
+     */
+    remove(element) {
+        if (element === this.focusedElement) {
+            this._blur();
+        }
+        if (this._elements.has(element)) {
+            this.stopListening(element);
+            this._elements.delete(element);
+        }
+    }
+    /**
+     * Destroys the focus tracker by:
+     * - Disabling all event listeners attached to tracked elements.
+     * - Removing all tracked elements that were previously added.
+     */
+    destroy() {
+        this.stopListening();
+    }
+    /**
+     * Stores currently focused element and set {#isFocused} as `true`.
+     *
+     * @private
+     * @param {Element} element Element which has been focused.
+     */
+    _focus(element) {
+        clearTimeout(this._nextEventLoopTimeout);
+        this.focusedElement = element;
+        this.isFocused = true;
+    }
+    /**
+     * Clears currently focused element and set {@link #isFocused} as `false`.
+     * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
+     *
+     * @private
+     * @fires blur
+     */
+    _blur() {
+        clearTimeout(this._nextEventLoopTimeout);
+        this._nextEventLoopTimeout = setTimeout(() => {
+            this.focusedElement = null;
+            this.isFocused = false;
+        }, 0);
+    }
 }
-
-mix( FocusTracker, DomEmitterMixin );
-mix( FocusTracker, ObservableMixin );

package/src/index.js

@@ -2,22 +2,16 @@
  * @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 utils
  */
-
 export { default as env } from './env';
 export { default as diff } from './diff';
-
 export { default as mix } from './mix';
 export { default as EmitterMixin } from './emittermixin';
 export { default as ObservableMixin } from './observablemixin';
-
 export { default as CKEditorError, logError, logWarning } from './ckeditorerror';
-
 export { default as ElementReplacer } from './elementreplacer';
-
 export { default as createElement } from './dom/createelement';
 export { default as DomEmitterMixin } from './dom/emittermixin';
 export { default as global } from './dom/global';
@@ -28,7 +22,6 @@ export { default as setDataInElement } from './dom/setdatainelement';
 export { default as toUnit } from './dom/tounit';
 export { default as isVisible } from './dom/isvisible';
 export * from './dom/scroll';
-
 export * from './keyboard';
 export * from './language';
 export { default as Locale } from './locale';
@@ -39,7 +32,5 @@ export { default as KeystrokeHandler } from './keystrokehandler';
 export { default as toArray } from './toarray';
 export { default as toMap } from './tomap';
 export { default as priorities } from './priorities';
-
 export { default as uid } from './uid';
-
 export { default as version } from './version';

package/src/inserttopriorityarray.js

@@ -2,41 +2,20 @@
  * @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 priorities from './priorities';
-
-/**
- * @module utils/inserttopriorityarray
- */
-
-/**
- * The priority object descriptor.
- *
- *		const objectWithPriority = {
- *			priority: 'high'
- *		}
- *
- * @typedef {Object} module:utils/inserttopriorityarray~ObjectWithPriority
- *
- * @property {module:utils/priorities~PriorityString|Number} priority Priority of the object.
- */
-
 /**
  * Inserts any object with priority at correct index by priority so registered objects are always sorted from highest to lowest priority.
  *
  * @param {Array.<module:utils/inserttopriorityarray~ObjectWithPriority>} objects Array of objects with priority to insert object to.
  * @param {module:utils/inserttopriorityarray~ObjectWithPriority} objectToInsert Object with `priority` property.
  */
-export default function insertToPriorityArray( objects, objectToInsert ) {
-	const priority = priorities.get( objectToInsert.priority );
-
-	for ( let i = 0; i < objects.length; i++ ) {
-		if ( priorities.get( objects[ i ].priority ) < priority ) {
-			objects.splice( i, 0, objectToInsert );
-
-			return;
-		}
-	}
-
-	objects.push( objectToInsert );
+export default function insertToPriorityArray(objects, objectToInsert) {
+    const priority = priorities.get(objectToInsert.priority);
+    for (let i = 0; i < objects.length; i++) {
+        if (priorities.get(objects[i].priority) < priority) {
+            objects.splice(i, 0, objectToInsert);
+            return;
+        }
+    }
+    objects.push(objectToInsert);
 }

package/src/isiterable.js

@@ -2,17 +2,15 @@
  * @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 utils/isiterable
  */
-
 /**
  * Checks if value implements iterator interface.
  *
  * @param {*} value The value to check.
  * @returns {Boolean} True if value implements iterator interface.
  */
-export default function isIterable( value ) {
-	return !!( value && value[ Symbol.iterator ] );
+export default function isIterable(value) {
+    return !!(value && value[Symbol.iterator]);
 }