npm - @ckeditor/ckeditor5-utils - Versions diffs - 34.2.0 → 35.0.0 - Mend

@ckeditor/ckeditor5-utils 34.2.0 → 35.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

package/CHANGELOG.md +324 -0
package/LICENSE.md +1 -1
package/package.json +19 -8
package/src/areconnectedthroughproperties.js +0 -92
package/src/ckeditorerror.js +0 -217
package/src/collection.js +0 -785
package/src/comparearrays.js +0 -51
package/src/config.js +0 -246
package/src/count.js +0 -26
package/src/diff.js +0 -138
package/src/difftochanges.js +0 -86
package/src/dom/createelement.js +0 -49
package/src/dom/emittermixin.js +0 -341
package/src/dom/getancestors.js +0 -31
package/src/dom/getborderwidths.js +0 -27
package/src/dom/getcommonancestor.js +0 -31
package/src/dom/getdatafromelement.js +0 -24
package/src/dom/getpositionedancestor.js +0 -28
package/src/dom/global.js +0 -26
package/src/dom/indexof.js +0 -25
package/src/dom/insertat.js +0 -19
package/src/dom/iscomment.js +0 -20
package/src/dom/isnode.js +0 -26
package/src/dom/isrange.js +0 -18
package/src/dom/istext.js +0 -18
package/src/dom/isvisible.js +0 -25
package/src/dom/iswindow.js +0 -30
package/src/dom/position.js +0 -518
package/src/dom/rect.js +0 -443
package/src/dom/remove.js +0 -21
package/src/dom/resizeobserver.js +0 -378
package/src/dom/scroll.js +0 -302
package/src/dom/setdatainelement.js +0 -24
package/src/dom/tounit.js +0 -27
package/src/elementreplacer.js +0 -57
package/src/emittermixin.js +0 -719
package/src/env.js +0 -190
package/src/eventinfo.js +0 -79
package/src/fastdiff.js +0 -261
package/src/first.js +0 -24
package/src/focustracker.js +0 -157
package/src/index.js +0 -45
package/src/inserttopriorityarray.js +0 -42
package/src/isiterable.js +0 -18
package/src/keyboard.js +0 -301
package/src/keystrokehandler.js +0 -130
package/src/language.js +0 -26
package/src/locale.js +0 -176
package/src/mapsequal.js +0 -32
package/src/mix.js +0 -47
package/src/nth.js +0 -31
package/src/objecttomap.js +0 -29
package/src/observablemixin.js +0 -908
package/src/priorities.js +0 -44
package/src/spy.js +0 -25
package/src/toarray.js +0 -18
package/src/tomap.js +0 -29
package/src/translation-service.js +0 -216
package/src/uid.js +0 -59
package/src/unicode.js +0 -106
package/src/version.js +0 -157

package/src/dom/iswindow.js DELETED Viewed

@@ -1,30 +0,0 @@
-/**
- * @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/dom/iswindow
- */
-/**
- * Checks if the object is a native DOM Window.
- *
- * @param {*} obj
- * @returns {Boolean}
- */
-export default function isWindow( obj ) {
-	const stringifiedObject = Object.prototype.toString.apply( obj );
-	// Returns `true` for the `window` object in browser environments.
-	if ( stringifiedObject == '[object Window]' ) {
-		return true;
-	}
-	// Returns `true` for the `window` object in the Electron environment.
-	if ( stringifiedObject == '[object global]' ) {
-		return true;
-	}
-	return false;
-}

package/src/dom/position.js DELETED Viewed

@@ -1,518 +0,0 @@
-/**
- * @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/dom/position
- */
-import global from './global';
-import Rect from './rect';
-import getPositionedAncestor from './getpositionedancestor';
-import getBorderWidths from './getborderwidths';
-import { isFunction } from 'lodash-es';
-// @if CK_DEBUG_POSITION // import { RectDrawer } from '@ckeditor/ckeditor5-minimap/src/utils';
-/**
- * Calculates the `position: absolute` coordinates of a given element so it can be positioned with respect to the
- * target in the visually most efficient way, taking various restrictions like viewport or limiter geometry
- * into consideration.
- *
- *		// The element which is to be positioned.
- *		const element = document.body.querySelector( '#toolbar' );
- *
- *		// A target to which the element is positioned relatively.
- *		const target = document.body.querySelector( '#container' );
- *
- *		// Finding the optimal coordinates for the positioning.
- *		const { left, top, name } = getOptimalPosition( {
- *			element: element,
- *			target: target,
- *
- * 			// The algorithm will chose among these positions to meet the requirements such
- * 			// as "limiter" element or "fitInViewport", set below. The positions are considered
- * 			// in the order of the array.
- *			positions: [
- *				//
- *			 	//	[ Target ]
- *				//	+-----------------+
- *				//	|     Element     |
- *				//	+-----------------+
- *				//
- *				targetRect => ( {
- *					top: targetRect.bottom,
- *					left: targetRect.left,
- *					name: 'mySouthEastPosition'
- *				} ),
- *
- *				//
- *				//	+-----------------+
- *				//	|     Element     |
- *				//	+-----------------+
- *				//	[ Target ]
- *				//
- *				( targetRect, elementRect ) => ( {
- *					top: targetRect.top - elementRect.height,
- *					left: targetRect.left,
- *					name: 'myNorthEastPosition'
- *				} )
- *			],
- *
- *			// Find a position such guarantees the element remains within visible boundaries of <body>.
- *			limiter: document.body,
- *
- *			// Find a position such guarantees the element remains within visible boundaries of the browser viewport.
- *			fitInViewport: true
- *		} );
- *
- *		// The best position which fits into document.body and the viewport. May be useful
- *		// to set proper class on the `element`.
- *		console.log( name ); // -> "myNorthEastPosition"
- *
- *		// Using the absolute coordinates which has been found to position the element
- *		// as in the diagram depicting the "myNorthEastPosition" position.
- *		element.style.top = top;
- *		element.style.left = left;
- *
- * @param {module:utils/dom/position~Options} options The input data and configuration of the helper.
- * @returns {module:utils/dom/position~Position}
- */
-export function getOptimalPosition( { element, target, positions, limiter, fitInViewport, viewportOffsetConfig } ) {
-	// If the {@link module:utils/dom/position~Options#target} is a function, use what it returns.
-	// https://github.com/ckeditor/ckeditor5-utils/issues/157
-	if ( isFunction( target ) ) {
-		target = target();
-	}
-	// If the {@link module:utils/dom/position~Options#limiter} is a function, use what it returns.
-	// https://github.com/ckeditor/ckeditor5-ui/issues/260
-	if ( isFunction( limiter ) ) {
-		limiter = limiter();
-	}
-	const positionedElementAncestor = getPositionedAncestor( element );
-	const elementRect = new Rect( element );
-	const targetRect = new Rect( target );
-	let bestPosition;
-	// @if CK_DEBUG_POSITION // RectDrawer.clear();
-	// @if CK_DEBUG_POSITION // RectDrawer.draw( targetRect, { outlineWidth: '5px' }, 'Target' );
-	const positionOptions = { targetRect, elementRect, positionedElementAncestor };
-	// If there are no limits, just grab the very first position and be done with that drama.
-	if ( !limiter && !fitInViewport ) {
-		bestPosition = new Position( positions[ 0 ], positionOptions );
-	} else {
-		const limiterRect = limiter && new Rect( limiter ).getVisible();
-		const viewportRect = fitInViewport && getConstrainedViewportRect( viewportOffsetConfig );
-		// @if CK_DEBUG_POSITION // if ( viewportRect ) {
-		// @if CK_DEBUG_POSITION //		RectDrawer.draw( viewportRect, { outlineWidth: '5px' }, 'Viewport' );
-		// @if CK_DEBUG_POSITION // }
-		// @if CK_DEBUG_POSITION // if ( limiter ) {
-		// @if CK_DEBUG_POSITION // 	RectDrawer.draw( limiterRect, { outlineWidth: '5px', outlineColor: 'green' }, 'Visible limiter' );
-		// @if CK_DEBUG_POSITION // }
-		Object.assign( positionOptions, { limiterRect, viewportRect } );
-		// If there's no best position found, i.e. when all intersections have no area because
-		// rects have no width or height, then just use the first available position.
-		bestPosition = getBestPosition( positions, positionOptions ) || new Position( positions[ 0 ], positionOptions );
-	}
-	return bestPosition;
-}
-// Returns a viewport `Rect` shrunk by the viewport offset config from all sides.
-//
-// @private
-// @param {Object} An object containing viewportOffset config.
-// @returns {utils/dom/rect~Rect} A shrunken rect of the viewport.
-function getConstrainedViewportRect( viewportOffsetConfig ) {
-	viewportOffsetConfig = Object.assign( { top: 0, bottom: 0, left: 0, right: 0 }, viewportOffsetConfig );
-	const viewportRect = new Rect( global.window );
-	viewportRect.top += viewportOffsetConfig.top;
-	viewportRect.height -= viewportOffsetConfig.top;
-	viewportRect.bottom -= viewportOffsetConfig.bottom;
-	viewportRect.height -= viewportOffsetConfig.bottom;
-	return viewportRect;
-}
-// For a given array of positioning functions, returns such that provides the best
-// fit of the `elementRect` into the `limiterRect` and `viewportRect`.
-//
-// @private
-//
-// @param {Object} options
-// @param {module:utils/dom/position~Options#positions} positions Functions returning
-// {@link module:utils/dom/position~Position}to be checked, in the order of preference.
-// @param {Object} options
-// @param {utils/dom/rect~Rect} options.targetRect A rect of the {@link module:utils/dom/position~Options#target}.
-// @param {utils/dom/rect~Rect} options.elementRect A rect of positioned
-// {@link module:utils/dom/position~Options#element}.
-// @param {utils/dom/rect~Rect} options.limiterRect A rect of the {@link module:utils/dom/position~Options#limiter}.
-// @param {utils/dom/rect~Rect} options.viewportRect A rect of the {@link module:utils/dom/position~Options#viewport}.
-//
-// @returns {Array} An array containing the name of the position and it's rect.
-function getBestPosition( positions, options ) {
-	const { elementRect } = options;
-	// This is when element is fully visible.
-	const elementRectArea = elementRect.getArea();
-	const positionInstances = positions
-		.map( positioningFunction => new Position( positioningFunction, options ) )
-		// Some positioning functions may return `null` if they don't want to participate.
-		.filter( position => !!position.name );
-	let maxFitFactor = 0;
-	let bestPosition = null;
-	for ( const position of positionInstances ) {
-		const { _limiterIntersectionArea, _viewportIntersectionArea } = position;
-		// If a such position is found that element is fully contained by the limiter then, obviously,
-		// there will be no better one, so finishing.
-		if ( _limiterIntersectionArea === elementRectArea ) {
-			return position;
-		}
-		// To maximize both viewport and limiter intersection areas we use distance on _viewportIntersectionArea
-		// and _limiterIntersectionArea plane (without sqrt because we are looking for max value).
-		const fitFactor = _viewportIntersectionArea ** 2 + _limiterIntersectionArea ** 2;
-		if ( fitFactor > maxFitFactor ) {
-			maxFitFactor = fitFactor;
-			bestPosition = position;
-		}
-	}
-	return bestPosition;
-}
-// For a given absolute Rect coordinates object and a positioned element ancestor, it returns an object with
-// new Rect coordinates that make up for the position and the scroll of the ancestor.
-//
-// This is necessary because while Rects (and DOMRects) are relative to the browser's viewport, their coordinates
-// are used in real–life to position elements with `position: absolute`, which are scoped by any positioned
-// (and scrollable) ancestors.
-//
-// @private
-//
-// @param {utils/dom/rect~Rect} rect A rect with absolute rect coordinates.
-// @param {Number} rect.top
-// @param {Number} rect.left
-// @param {HTMLElement} positionedElementAncestor An ancestor element that should be considered.
-//
-// @returns {utils/dom/rect~Rect} A rect corresponding to `absoluteRect` input but with values shifted
-// to make up for the positioned element ancestor.
-function shiftRectToCompensatePositionedAncestor( rect, positionedElementAncestor ) {
-	const ancestorPosition = getRectForAbsolutePositioning( new Rect( positionedElementAncestor ) );
-	const ancestorBorderWidths = getBorderWidths( positionedElementAncestor );
-	let moveX = 0;
-	let moveY = 0;
-	// (https://github.com/ckeditor/ckeditor5-ui-default/issues/126)
-	// If there's some positioned ancestor of the panel, then its `Rect` must be taken into
-	// consideration. `Rect` is always relative to the viewport while `position: absolute` works
-	// with respect to that positioned ancestor.
-	moveX -= ancestorPosition.left;
-	moveY -= ancestorPosition.top;
-	// (https://github.com/ckeditor/ckeditor5-utils/issues/139)
-	// If there's some positioned ancestor of the panel, not only its position must be taken into
-	// consideration (see above) but also its internal scrolls. Scroll have an impact here because `Rect`
-	// is relative to the viewport (it doesn't care about scrolling), while `position: absolute`
-	// must compensate that scrolling.
-	moveX += positionedElementAncestor.scrollLeft;
-	moveY += positionedElementAncestor.scrollTop;
-	// (https://github.com/ckeditor/ckeditor5-utils/issues/139)
-	// If there's some positioned ancestor of the panel, then its `Rect` includes its CSS `borderWidth`
-	// while `position: absolute` positioning does not consider it.
-	// E.g. `{ position: absolute, top: 0, left: 0 }` means upper left corner of the element,
-	// not upper-left corner of its border.
-	moveX -= ancestorBorderWidths.left;
-	moveY -= ancestorBorderWidths.top;
-	rect.moveBy( moveX, moveY );
-}
-// DOMRect (also Rect) works in a scroll–independent geometry but `position: absolute` doesn't.
-// This function converts Rect to `position: absolute` coordinates.
-//
-// @private
-// @param {utils/dom/rect~Rect} rect A rect to be converted.
-// @returns {Object} Object containing `left` and `top` properties, in absolute coordinates.
-function getRectForAbsolutePositioning( rect ) {
-	const { scrollX, scrollY } = global.window;
-	return rect.clone().moveBy( scrollX, scrollY );
-}
-/**
- * A position class which instances are created and used by the {@link module:utils/dom/position~getOptimalPosition} helper.
- *
- * {@link module:utils/dom/position~Position#top} and {@link module:utils/dom/position~Position#left} properties of the position instance
- * translate directly to the `top` and `left` properties in CSS "`position: absolute` coordinate system". If set on the positioned element
- * in DOM, they will make it display it in the right place in the viewport.
- */
-export class Position {
-	/**
-	 * Creates an instance of the {@link module:utils/dom/position~Position} class.
-	 *
-	 * @param {module:utils/dom/position~positioningFunction} [positioningFunction] function The function that defines the expected
-	 * coordinates the positioned element should move to.
-	 * @param {Object} [options] options object.
-	 * @param {module:utils/dom/rect~Rect} options.elementRect The positioned element rect.
-	 * @param {module:utils/dom/rect~Rect} options.targetRect The target element rect.
-	 * @param {module:utils/dom/rect~Rect} options.viewportRect The viewport rect.
-	 * @param {HTMLElement|null} [options.positionedElementAncestor] Nearest element ancestor element which CSS position is not "static".
-	 */
-	constructor( positioningFunction, options ) {
-		const positioningFunctionOutput = positioningFunction( options.targetRect, options.elementRect, options.viewportRect );
-		// Nameless position for a function that didn't participate.
-		if ( !positioningFunctionOutput ) {
-			return;
-		}
-		const { left, top, name, config } = positioningFunctionOutput;
-		Object.assign( this, { name, config } );
-		this._positioningFunctionCorrdinates = { left, top };
-		this._options = options;
-		/**
-		 * Position name.
-		 *
-		 * @readonly
-		 * @member {String} #name
-		 */
-		/**
-		 * Additional position configuration, as passed from the {@link module:utils/dom/position~positioningFunction positioning function}.
-		 *
-		 * This object can be use, for instance, to pass through presentation options used by the consumer of the
-		 * {@link module:utils/dom/position~getOptimalPosition} helper.
-		 *
-		 * @readonly
-		 * @member {Object} #config
-		 */
-	}
-	/**
-	 * The left value in pixels in the CSS `position: absolute` coordinate system.
-	 * Set it on the positioned element in DOM to move it to the position.
-	 *
-	 * @readonly
-	 * @type {Number}
-	 */
-	get left() {
-		return this._absoluteRect.left;
-	}
-	/**
-	 * The top value in pixels in the CSS `position: absolute` coordinate system.
-	 * Set it on the positioned element in DOM to move it to the position.
-	 *
-	 * @readonly
-	 * @type {Number}
-	 */
-	get top() {
-		return this._absoluteRect.top;
-	}
-	/**
-	 * An intersection area between positioned element and limiter within viewport constraints.
-	 *
-	 * @readonly
-	 * @private
-	 * @type {Number}
-	 */
-	get _limiterIntersectionArea() {
-		const limiterRect = this._options.limiterRect;
-		if ( limiterRect ) {
-			const viewportRect = this._options.viewportRect;
-			if ( viewportRect ) {
-				// Consider only the part of the limiter which is visible in the viewport. So the limiter is getting limited.
-				const limiterViewportIntersectRect = limiterRect.getIntersection( viewportRect );
-				if ( limiterViewportIntersectRect ) {
-					// If the limiter is within the viewport, then check the intersection between that part of the
-					// limiter and actual position.
-					return limiterViewportIntersectRect.getIntersectionArea( this._rect );
-				}
-			} else {
-				return limiterRect.getIntersectionArea( this._rect );
-			}
-		}
-		return 0;
-	}
-	/**
-	 * An intersection area between positioned element and viewport.
-	 *
-	 * @readonly
-	 * @private
-	 * @type {Number}
-	 */
-	get _viewportIntersectionArea() {
-		const viewportRect = this._options.viewportRect;
-		if ( viewportRect ) {
-			return viewportRect.getIntersectionArea( this._rect );
-		}
-		return 0;
-	}
-	/**
-	 * An already positioned element rect. A clone of the element rect passed to the constructor
-	 * but placed in the viewport according to the positioning function.
-	 *
-	 * @private
-	 * @type {module:utils/dom/rect~Rect}
-	 */
-	get _rect() {
-		if ( this._cachedRect ) {
-			return this._cachedRect;
-		}
-		this._cachedRect = this._options.elementRect.clone().moveTo(
-			this._positioningFunctionCorrdinates.left,
-			this._positioningFunctionCorrdinates.top
-		);
-		return this._cachedRect;
-	}
-	/**
-	 * An already absolutely positioned element rect. See ({@link #_rect}).
-	 *
-	 * @private
-	 * @type {module:utils/dom/rect~Rect}
-	 */
-	get _absoluteRect() {
-		if ( this._cachedAbsoluteRect ) {
-			return this._cachedAbsoluteRect;
-		}
-		this._cachedAbsoluteRect = getRectForAbsolutePositioning( this._rect );
-		if ( this._options.positionedElementAncestor ) {
-			shiftRectToCompensatePositionedAncestor( this._cachedAbsoluteRect, this._options.positionedElementAncestor );
-		}
-		return this._cachedAbsoluteRect;
-	}
-}
-/**
- * The `getOptimalPosition()` helper options.
- *
- * @interface module:utils/dom/position~Options
- */
-/**
- * Element that is to be positioned.
- *
- * @member {HTMLElement} #element
- */
-/**
- * Target with respect to which the `element` is to be positioned.
- *
- * @member {HTMLElement|Range|Window|ClientRect|DOMRect|module:utils/dom/rect~Rect|Object|Function} #target
- */
-/**
- * An array of positioning functions.
- *
- * **Note**: Positioning functions are processed in the order of preference. The first function that works
- * in the current environment (e.g. offers the complete fit in the viewport geometry) will be picked by
- * `getOptimalPosition()`.
- *
- * **Note**: Any positioning function returning `null` is ignored.
- *
- * @member {Array.<module:utils/dom/position~positioningFunction>} #positions
- */
-/**
- * When set, the algorithm will chose position which fits the most in the
- * limiter's bounding rect.
- *
- * @member {HTMLElement|Range|Window|ClientRect|DOMRect|module:utils/dom/rect~Rect|Object|Function} #limiter
- */
-/**
- * When set, the algorithm will chose such a position which fits `element`
- * the most inside visible viewport.
- *
- * @member {Boolean} #fitInViewport
- */
-/**
- * Viewport offset config object. It restricts the visible viewport available to the `getOptimalPosition()` from each side.
- *
- *		{
- *			top: 50,
- *			right: 50,
- *			bottom: 50,
- *			left: 50
- *		}
- *
- * @member {Object} #viewportOffsetConfig
- */
-/**
- * A positioning function which, based on positioned element and target {@link module:utils/dom/rect~Rect Rects}, returns rect coordinates
- * representing the geometrical relation between them. Used by the {@link module:utils/dom/position~getOptimalPosition} helper.
- *
- *		// This simple position will place the element directly under the target, in the middle:
- *		//
- *		//	    [ Target ]
- *		//	+-----------------+
- *		//	|     Element     |
- *		//	+-----------------+
- *		//
- *		const position = ( targetRect, elementRect, [ viewportRect ] ) => ( {
- *			top: targetRect.bottom,
- *			left: targetRect.left + targetRect.width / 2 - elementRect.width / 2,
- *			name: 'bottomMiddle',
- *
- *			// Note: The config is optional.
- *			config: {
- *				zIndex: '999'
- *			}
- *		} );
- *
- * @callback module:utils/dom/position~positioningFunction
- * @param {module:utils/dom/rect~Rect} elementRect The rect of the element to be positioned.
- * @param {module:utils/dom/rect~Rect} targetRect The rect of the target the element (its rect) is relatively positioned to.
- * @param {module:utils/dom/rect~Rect} viewportRect The rect of the visual browser viewport.
- * @returns {Object|null} return When the function returns `null`, it will not be considered by
- * {@link module:utils/dom/position~getOptimalPosition}.
- * @returns {Number} return.top The `top` value of the element rect that would represent the position.
- * @returns {Number} return.left The `left` value of the element rect that would represent the position.
- * @returns {Number} return.name The name of the position. It helps the user of the {@link module:utils/dom/position~getOptimalPosition}
- * helper to recognize different positioning function results. It will pass through to the {@link module:utils/dom/position~Position}
- * returned by the helper.
- * @returns {Number} [return.config] An optional configuration that will pass-through the
- * {@link module:utils/dom/position~getOptimalPosition} helper to the {@link module:utils/dom/position~Position} returned by this helper.
- * This configuration may, for instance, let the user of {@link module:utils/dom/position~getOptimalPosition} know that this particular
- * position comes with a certain presentation.
- */