npm - @ckeditor/ckeditor5-utils - Versions diffs - 39.0.2 → 40.0.0 - Mend

@ckeditor/ckeditor5-utils 39.0.2 → 40.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 (131) hide show

package/package.json +1 -1
package/src/areconnectedthroughproperties.d.ts +11 -11
package/src/areconnectedthroughproperties.js +73 -73
package/src/ckeditorerror.d.ts +123 -123
package/src/ckeditorerror.js +176 -176
package/src/collection.d.ts +427 -427
package/src/collection.js +575 -575
package/src/comparearrays.d.ts +30 -30
package/src/comparearrays.js +47 -47
package/src/config.d.ts +163 -163
package/src/config.js +162 -162
package/src/count.d.ts +18 -18
package/src/count.js +24 -24
package/src/delay.d.ts +19 -19
package/src/delay.js +26 -26
package/src/diff.d.ts +31 -31
package/src/diff.js +115 -115
package/src/difftochanges.d.ts +59 -59
package/src/difftochanges.js +79 -79
package/src/dom/createelement.d.ts +57 -57
package/src/dom/createelement.js +40 -40
package/src/dom/emittermixin.d.ts +142 -142
package/src/dom/emittermixin.js +239 -239
package/src/dom/findclosestscrollableancestor.d.ts +11 -11
package/src/dom/findclosestscrollableancestor.js +31 -31
package/src/dom/getancestors.d.ts +17 -17
package/src/dom/getancestors.js +27 -27
package/src/dom/getborderwidths.d.ts +24 -24
package/src/dom/getborderwidths.js +24 -24
package/src/dom/getcommonancestor.d.ts +12 -12
package/src/dom/getcommonancestor.js +25 -25
package/src/dom/getdatafromelement.d.ts +14 -14
package/src/dom/getdatafromelement.js +20 -20
package/src/dom/getpositionedancestor.d.ts +10 -10
package/src/dom/getpositionedancestor.js +22 -22
package/src/dom/global.d.ts +32 -32
package/src/dom/global.js +35 -35
package/src/dom/indexof.d.ts +14 -14
package/src/dom/indexof.js +21 -21
package/src/dom/insertat.d.ts +15 -15
package/src/dom/insertat.js +17 -17
package/src/dom/iscomment.d.ts +11 -11
package/src/dom/iscomment.js +14 -14
package/src/dom/isnode.d.ts +11 -11
package/src/dom/isnode.js +21 -21
package/src/dom/isrange.d.ts +11 -11
package/src/dom/isrange.js +13 -13
package/src/dom/istext.d.ts +11 -11
package/src/dom/istext.js +13 -13
package/src/dom/isvalidattributename.d.ts +10 -10
package/src/dom/isvalidattributename.js +22 -22
package/src/dom/isvisible.d.ts +18 -18
package/src/dom/isvisible.js +20 -20
package/src/dom/iswindow.d.ts +11 -11
package/src/dom/iswindow.js +22 -22
package/src/dom/position.d.ts +211 -208
package/src/dom/position.js +313 -305
package/src/dom/rect.d.ts +195 -191
package/src/dom/rect.js +474 -388
package/src/dom/remove.d.ts +13 -13
package/src/dom/remove.js +18 -18
package/src/dom/resizeobserver.d.ts +74 -74
package/src/dom/resizeobserver.js +126 -126
package/src/dom/scroll.d.ts +73 -73
package/src/dom/scroll.js +383 -383
package/src/dom/setdatainelement.d.ts +14 -14
package/src/dom/setdatainelement.js +20 -20
package/src/dom/tounit.d.ts +22 -22
package/src/dom/tounit.js +16 -16
package/src/elementreplacer.d.ts +31 -31
package/src/elementreplacer.js +43 -43
package/src/emittermixin.d.ts +312 -312
package/src/emittermixin.js +453 -453
package/src/env.d.ts +117 -117
package/src/env.js +122 -122
package/src/eventinfo.d.ts +58 -58
package/src/eventinfo.js +26 -26
package/src/fastdiff.d.ts +112 -112
package/src/fastdiff.js +248 -248
package/src/first.d.ts +11 -11
package/src/first.js +17 -17
package/src/focustracker.d.ts +75 -75
package/src/focustracker.js +95 -95
package/src/index.d.ts +61 -62
package/src/index.js +60 -61
package/src/inserttopriorityarray.d.ts +30 -30
package/src/inserttopriorityarray.js +21 -21
package/src/isiterable.d.ts +14 -14
package/src/isiterable.js +16 -16
package/src/keyboard.d.ts +126 -126
package/src/keyboard.js +221 -221
package/src/keystrokehandler.d.ts +87 -87
package/src/keystrokehandler.js +122 -122
package/src/language.d.ts +17 -17
package/src/language.js +19 -19
package/src/locale.d.ts +120 -120
package/src/locale.js +76 -76
package/src/mapsequal.d.ts +15 -15
package/src/mapsequal.js +27 -27
package/src/mix.d.ts +85 -85
package/src/mix.js +50 -50
package/src/nth.d.ts +16 -16
package/src/nth.js +24 -24
package/src/objecttomap.d.ts +23 -23
package/src/objecttomap.js +27 -27
package/src/observablemixin.d.ts +560 -560
package/src/observablemixin.js +580 -580
package/src/priorities.d.ts +33 -33
package/src/priorities.js +23 -23
package/src/splicearray.d.ts +26 -26
package/src/splicearray.js +40 -40
package/src/spy.d.ts +21 -21
package/src/spy.js +22 -22
package/src/toarray.d.ts +25 -25
package/src/toarray.js +7 -7
package/src/tomap.d.ts +19 -19
package/src/tomap.js +29 -29
package/src/translation-service.d.ts +168 -168
package/src/translation-service.js +198 -198
package/src/uid.d.ts +15 -15
package/src/uid.js +57 -57
package/src/unicode.d.ts +54 -54
package/src/unicode.js +85 -85
package/src/verifylicense.d.ts +15 -15
package/src/verifylicense.js +87 -87
package/src/version.d.ts +10 -10
package/src/version.js +153 -153
package/src/dom/getelementsintersectionrect.d.ts +0 -14
package/src/dom/getelementsintersectionrect.js +0 -43
package/src/dom/getscrollableancestors.d.ts +0 -14
package/src/dom/getscrollableancestors.js +0 -28

package/src/dom/position.d.ts CHANGED Viewed

@@ -1,208 +1,211 @@
-/**
- * @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
- */
-import Rect, { type RectSource } from './rect';
-/**
- * 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.
- *
- * ```ts
- * // 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 options The input data and configuration of the helper.
- */
-export declare function getOptimalPosition({ element, target, positions, limiter, fitInViewport, viewportOffsetConfig }: Options): Position;
-/**
- * A position object 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 interface Position {
-    /**
-     * Position name.
-     */
-    readonly name?: string;
-    /**
-     * 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 config?: object;
-    /**
-     * 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 left: number;
-    /**
-     * 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 top: number;
-}
-/**
- * The `getOptimalPosition()` helper options.
- */
-export interface Options {
-    /**
-     * Element that is to be positioned.
-     */
-    readonly element: HTMLElement;
-    /**
-     * Target with respect to which the `element` is to be positioned.
-     */
-    readonly target: RectSource | (() => RectSource);
-    /**
-     * 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.
-     */
-    readonly positions: ReadonlyArray<PositioningFunction>;
-    /**
-     * When set, the algorithm will chose position which fits the most in the
-     * limiter's bounding rect.
-     */
-    readonly limiter?: RectSource | (() => (RectSource | null)) | null;
-    /**
-     * When set, the algorithm will chose such a position which fits `element`
-     * the most inside visible viewport.
-     */
-    readonly fitInViewport?: boolean;
-    /**
-     * Viewport offset config object. It restricts the visible viewport available to the `getOptimalPosition()` from each side.
-     *
-     * ```ts
-     * {
-     * 	top: 50,
-     * 	right: 50,
-     * 	bottom: 50,
-     * 	left: 50
-     * }
-     * ```
-     */
-    readonly viewportOffsetConfig?: {
-        readonly top?: number;
-        readonly right?: number;
-        readonly bottom?: number;
-        readonly left?: number;
-    };
-}
-/**
- * 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.
- *
- * ```ts
- * // 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'
- * 	}
- * } );
- * ```
- *
- * @param elementRect The rect of the element to be positioned.
- * @param targetRect The rect of the target the element (its rect) is relatively positioned to.
- * @param viewportRect The rect of the visual browser viewport.
- * @returns When the function returns `null`, it will not be considered by {@link module:utils/dom/position~getOptimalPosition}.
- */
-export type PositioningFunction = (elementRect: Rect, targetRect: Rect, viewportRect: Rect | null) => PositioningFunctionResult | null;
-/**
- * The result of {@link module:utils/dom/position~PositioningFunction}.
- */
-export interface PositioningFunctionResult {
-    /**
-     * The `top` value of the element rect that would represent the position.
-     */
-    top: number;
-    /**
-     * The `left` value of the element rect that would represent the position.
-     */
-    left: number;
-    /**
-     * 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.
-     */
-    name?: string;
-    /**
-     * 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.
-     */
-    config?: object;
-}
+/**
+ * @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
+ */
+import Rect, { type RectSource } from './rect';
+/**
+ * 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.
+ *
+ * **Note**: If there are no position coordinates found that meet the requirements (arguments of this helper),
+ * `null` is returned.
+ *
+ * ```ts
+ * // 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 options The input data and configuration of the helper.
+ */
+export declare function getOptimalPosition({ element, target, positions, limiter, fitInViewport, viewportOffsetConfig }: Options): Position | null;
+/**
+ * A position object 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 interface Position {
+    /**
+     * Position name.
+     */
+    readonly name?: string;
+    /**
+     * 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 config?: object;
+    /**
+     * 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 left: number;
+    /**
+     * 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 top: number;
+}
+/**
+ * The `getOptimalPosition()` helper options.
+ */
+export interface Options {
+    /**
+     * Element that is to be positioned.
+     */
+    readonly element: HTMLElement;
+    /**
+     * Target with respect to which the `element` is to be positioned.
+     */
+    readonly target: RectSource | (() => RectSource);
+    /**
+     * 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.
+     */
+    readonly positions: ReadonlyArray<PositioningFunction>;
+    /**
+     * When set, the algorithm will chose position which fits the most in the
+     * limiter's bounding rect.
+     */
+    readonly limiter?: RectSource | (() => (RectSource | null)) | null;
+    /**
+     * When set, the algorithm will chose such a position which fits `element`
+     * the most inside visible viewport.
+     */
+    readonly fitInViewport?: boolean;
+    /**
+     * Viewport offset config object. It restricts the visible viewport available to the `getOptimalPosition()` from each side.
+     *
+     * ```ts
+     * {
+     * 	top: 50,
+     * 	right: 50,
+     * 	bottom: 50,
+     * 	left: 50
+     * }
+     * ```
+     */
+    readonly viewportOffsetConfig?: {
+        readonly top?: number;
+        readonly right?: number;
+        readonly bottom?: number;
+        readonly left?: number;
+    };
+}
+/**
+ * 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.
+ *
+ * ```ts
+ * // 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'
+ * 	}
+ * } );
+ * ```
+ *
+ * @param elementRect The rect of the element to be positioned.
+ * @param targetRect The rect of the target the element (its rect) is relatively positioned to.
+ * @param viewportRect The rect of the visual browser viewport.
+ * @returns When the function returns `null`, it will not be considered by {@link module:utils/dom/position~getOptimalPosition}.
+ */
+export type PositioningFunction = (elementRect: Rect, targetRect: Rect, viewportRect: Rect, limiterRect?: Rect) => PositioningFunctionResult | null;
+/**
+ * The result of {@link module:utils/dom/position~PositioningFunction}.
+ */
+export interface PositioningFunctionResult {
+    /**
+     * The `top` value of the element rect that would represent the position.
+     */
+    top: number;
+    /**
+     * The `left` value of the element rect that would represent the position.
+     */
+    left: number;
+    /**
+     * 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.
+     */
+    name?: string;
+    /**
+     * 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.
+     */
+    config?: object;
+}