npm - @ckeditor/ckeditor5-utils - Versions diffs - 0.0.0-internal-20241017.0 - Mend

@ckeditor/ckeditor5-utils 0.0.0-internal-20241017.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 (213) hide show

package/CHANGELOG.md +4 -0
package/LICENSE.md +21 -0
package/README.md +22 -0
package/dist/abortabledebounce.d.ts +21 -0
package/dist/areconnectedthroughproperties.d.ts +15 -0
package/dist/ckeditorerror.d.ts +127 -0
package/dist/collection.d.ts +437 -0
package/dist/comparearrays.d.ts +34 -0
package/dist/config.d.ts +167 -0
package/dist/count.d.ts +22 -0
package/dist/crc32.d.ts +30 -0
package/dist/delay.d.ts +23 -0
package/dist/diff.d.ts +35 -0
package/dist/difftochanges.d.ts +63 -0
package/dist/dom/createelement.d.ts +61 -0
package/dist/dom/emittermixin.d.ts +146 -0
package/dist/dom/findclosestscrollableancestor.d.ts +15 -0
package/dist/dom/getancestors.d.ts +21 -0
package/dist/dom/getborderwidths.d.ts +28 -0
package/dist/dom/getcommonancestor.d.ts +16 -0
package/dist/dom/getdatafromelement.d.ts +18 -0
package/dist/dom/getpositionedancestor.d.ts +14 -0
package/dist/dom/getrangefrommouseevent.d.ts +21 -0
package/dist/dom/global.d.ts +36 -0
package/dist/dom/indexof.d.ts +18 -0
package/dist/dom/insertat.d.ts +19 -0
package/dist/dom/iscomment.d.ts +15 -0
package/dist/dom/isnode.d.ts +15 -0
package/dist/dom/isrange.d.ts +15 -0
package/dist/dom/istext.d.ts +15 -0
package/dist/dom/isvalidattributename.d.ts +14 -0
package/dist/dom/isvisible.d.ts +19 -0
package/dist/dom/iswindow.d.ts +15 -0
package/dist/dom/position.d.ts +215 -0
package/dist/dom/rect.d.ts +199 -0
package/dist/dom/remove.d.ts +17 -0
package/dist/dom/resizeobserver.d.ts +78 -0
package/dist/dom/scroll.d.ts +77 -0
package/dist/dom/setdatainelement.d.ts +18 -0
package/dist/dom/tounit.d.ts +26 -0
package/dist/elementreplacer.d.ts +35 -0
package/dist/emittermixin.d.ts +316 -0
package/dist/env.d.ts +144 -0
package/dist/eventinfo.d.ts +62 -0
package/dist/fastdiff.d.ts +116 -0
package/dist/first.d.ts +15 -0
package/dist/focustracker.d.ts +83 -0
package/dist/index-content.css +4 -0
package/dist/index-editor.css +4 -0
package/dist/index.css +4 -0
package/dist/index.d.ts +70 -0
package/dist/index.js +5871 -0
package/dist/index.js.map +1 -0
package/dist/inserttopriorityarray.d.ts +34 -0
package/dist/isiterable.d.ts +18 -0
package/dist/keyboard.d.ts +130 -0
package/dist/keystrokehandler.d.ts +101 -0
package/dist/language.d.ts +21 -0
package/dist/locale.d.ts +145 -0
package/dist/mapsequal.d.ts +19 -0
package/dist/mix.d.ts +89 -0
package/dist/nth.d.ts +20 -0
package/dist/objecttomap.d.ts +27 -0
package/dist/observablemixin.d.ts +564 -0
package/dist/parsebase64encodedobject.d.ts +15 -0
package/dist/priorities.d.ts +37 -0
package/dist/retry.d.ts +37 -0
package/dist/splicearray.d.ts +30 -0
package/dist/spy.d.ts +25 -0
package/dist/toarray.d.ts +29 -0
package/dist/tomap.d.ts +23 -0
package/dist/translation-service.d.ts +178 -0
package/dist/uid.d.ts +19 -0
package/dist/unicode.d.ts +58 -0
package/dist/version.d.ts +14 -0
package/dist/wait.d.ts +20 -0
package/package.json +36 -0
package/src/abortabledebounce.d.ts +17 -0
package/src/abortabledebounce.js +22 -0
package/src/areconnectedthroughproperties.d.ts +11 -0
package/src/areconnectedthroughproperties.js +73 -0
package/src/ckeditorerror.d.ts +123 -0
package/src/ckeditorerror.js +176 -0
package/src/collection.d.ts +433 -0
package/src/collection.js +583 -0
package/src/comparearrays.d.ts +30 -0
package/src/comparearrays.js +47 -0
package/src/config.d.ts +163 -0
package/src/config.js +163 -0
package/src/count.d.ts +18 -0
package/src/count.js +25 -0
package/src/crc32.d.ts +26 -0
package/src/crc32.js +61 -0
package/src/delay.d.ts +19 -0
package/src/delay.js +26 -0
package/src/diff.d.ts +31 -0
package/src/diff.js +115 -0
package/src/difftochanges.d.ts +59 -0
package/src/difftochanges.js +79 -0
package/src/dom/createelement.d.ts +57 -0
package/src/dom/createelement.js +40 -0
package/src/dom/emittermixin.d.ts +142 -0
package/src/dom/emittermixin.js +239 -0
package/src/dom/findclosestscrollableancestor.d.ts +11 -0
package/src/dom/findclosestscrollableancestor.js +31 -0
package/src/dom/getancestors.d.ts +17 -0
package/src/dom/getancestors.js +27 -0
package/src/dom/getborderwidths.d.ts +24 -0
package/src/dom/getborderwidths.js +24 -0
package/src/dom/getcommonancestor.d.ts +12 -0
package/src/dom/getcommonancestor.js +25 -0
package/src/dom/getdatafromelement.d.ts +14 -0
package/src/dom/getdatafromelement.js +20 -0
package/src/dom/getpositionedancestor.d.ts +10 -0
package/src/dom/getpositionedancestor.js +22 -0
package/src/dom/getrangefrommouseevent.d.ts +17 -0
package/src/dom/getrangefrommouseevent.js +33 -0
package/src/dom/global.d.ts +32 -0
package/src/dom/global.js +35 -0
package/src/dom/indexof.d.ts +14 -0
package/src/dom/indexof.js +21 -0
package/src/dom/insertat.d.ts +15 -0
package/src/dom/insertat.js +17 -0
package/src/dom/iscomment.d.ts +11 -0
package/src/dom/iscomment.js +14 -0
package/src/dom/isnode.d.ts +11 -0
package/src/dom/isnode.js +21 -0
package/src/dom/isrange.d.ts +11 -0
package/src/dom/isrange.js +13 -0
package/src/dom/istext.d.ts +11 -0
package/src/dom/istext.js +13 -0
package/src/dom/isvalidattributename.d.ts +10 -0
package/src/dom/isvalidattributename.js +22 -0
package/src/dom/isvisible.d.ts +15 -0
package/src/dom/isvisible.js +30 -0
package/src/dom/iswindow.d.ts +11 -0
package/src/dom/iswindow.js +22 -0
package/src/dom/position.d.ts +211 -0
package/src/dom/position.js +313 -0
package/src/dom/rect.d.ts +195 -0
package/src/dom/rect.js +474 -0
package/src/dom/remove.d.ts +13 -0
package/src/dom/remove.js +18 -0
package/src/dom/resizeobserver.d.ts +74 -0
package/src/dom/resizeobserver.js +127 -0
package/src/dom/scroll.d.ts +73 -0
package/src/dom/scroll.js +383 -0
package/src/dom/setdatainelement.d.ts +14 -0
package/src/dom/setdatainelement.js +20 -0
package/src/dom/tounit.d.ts +22 -0
package/src/dom/tounit.js +16 -0
package/src/elementreplacer.d.ts +31 -0
package/src/elementreplacer.js +43 -0
package/src/emittermixin.d.ts +312 -0
package/src/emittermixin.js +453 -0
package/src/env.d.ts +140 -0
package/src/env.js +145 -0
package/src/eventinfo.d.ts +58 -0
package/src/eventinfo.js +26 -0
package/src/fastdiff.d.ts +112 -0
package/src/fastdiff.js +248 -0
package/src/first.d.ts +11 -0
package/src/first.js +17 -0
package/src/focustracker.d.ts +79 -0
package/src/focustracker.js +101 -0
package/src/index.d.ts +66 -0
package/src/index.js +65 -0
package/src/inserttopriorityarray.d.ts +30 -0
package/src/inserttopriorityarray.js +21 -0
package/src/isiterable.d.ts +14 -0
package/src/isiterable.js +16 -0
package/src/keyboard.d.ts +126 -0
package/src/keyboard.js +252 -0
package/src/keystrokehandler.d.ts +97 -0
package/src/keystrokehandler.js +122 -0
package/src/language.d.ts +17 -0
package/src/language.js +20 -0
package/src/locale.d.ts +141 -0
package/src/locale.js +78 -0
package/src/mapsequal.d.ts +15 -0
package/src/mapsequal.js +27 -0
package/src/mix.d.ts +85 -0
package/src/mix.js +50 -0
package/src/nth.d.ts +16 -0
package/src/nth.js +24 -0
package/src/objecttomap.d.ts +23 -0
package/src/objecttomap.js +27 -0
package/src/observablemixin.d.ts +560 -0
package/src/observablemixin.js +580 -0
package/src/parsebase64encodedobject.d.ts +11 -0
package/src/parsebase64encodedobject.js +22 -0
package/src/priorities.d.ts +33 -0
package/src/priorities.js +23 -0
package/src/retry.d.ts +33 -0
package/src/retry.js +47 -0
package/src/splicearray.d.ts +26 -0
package/src/splicearray.js +40 -0
package/src/spy.d.ts +21 -0
package/src/spy.js +22 -0
package/src/toarray.d.ts +25 -0
package/src/toarray.js +7 -0
package/src/tomap.d.ts +19 -0
package/src/tomap.js +29 -0
package/src/translation-service.d.ts +174 -0
package/src/translation-service.js +209 -0
package/src/uid.d.ts +15 -0
package/src/uid.js +45 -0
package/src/unicode.d.ts +54 -0
package/src/unicode.js +85 -0
package/src/version.d.ts +10 -0
package/src/version.js +179 -0
package/src/wait.d.ts +16 -0
package/src/wait.js +29 -0

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

@@ -0,0 +1,211 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+/**
+ * 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): DomPoint | null;
+/**
+ * A position object which instances are created and used by the {@link module:utils/dom/position~getOptimalPosition} helper.
+ *
+ * {@link module:utils/dom/position~DomPoint#top} and {@link module:utils/dom/position~DomPoint#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 DomPoint {
+    /**
+     * 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~DomPoint}
+     * 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~DomPoint} 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;
+}

package/src/dom/position.js ADDED Viewed

@@ -0,0 +1,313 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import Rect from './rect.js';
+import getPositionedAncestor from './getpositionedancestor.js';
+import { isFunction } from 'lodash-es';
+// @if CK_DEBUG_POSITION // const {
+// @if CK_DEBUG_POSITION // 	default: RectDrawer,
+// @if CK_DEBUG_POSITION // 	diagonalStylesBlack,
+// @if CK_DEBUG_POSITION // 	diagonalStylesGreen,
+// @if CK_DEBUG_POSITION // 	diagonalStylesRed
+// @if CK_DEBUG_POSITION // } = require( '@ckeditor/ckeditor5-utils/tests/_utils/rectdrawer' );
+// @if CK_DEBUG_POSITION // const TARGET_RECT_STYLE = {
+// @if CK_DEBUG_POSITION // 	outlineWidth: '2px', outlineStyle: 'dashed', outlineColor: 'blue', outlineOffset: '2px'
+// @if CK_DEBUG_POSITION // };
+// @if CK_DEBUG_POSITION // const VISIBLE_TARGET_RECT_STYLE = {
+// @if CK_DEBUG_POSITION //		...diagonalStylesBlack,
+// @if CK_DEBUG_POSITION //		opacity: '1',
+// @if CK_DEBUG_POSITION //		backgroundColor: '#00000033',
+// @if CK_DEBUG_POSITION //		outlineWidth: '2px'
+// @if CK_DEBUG_POSITION // };
+// @if CK_DEBUG_POSITION // const VIEWPORT_RECT_STYLE = {
+// @if CK_DEBUG_POSITION // 	outlineWidth: '2px',
+// @if CK_DEBUG_POSITION // 	outlineOffset: '-2px',
+// @if CK_DEBUG_POSITION // 	outlineStyle: 'solid',
+// @if CK_DEBUG_POSITION // 	outlineColor: 'red'
+// @if CK_DEBUG_POSITION // };
+// @if CK_DEBUG_POSITION // const VISIBLE_LIMITER_RECT_STYLE = {
+// @if CK_DEBUG_POSITION // 	...diagonalStylesGreen,
+// @if CK_DEBUG_POSITION // 	outlineWidth: '2px',
+// @if CK_DEBUG_POSITION // 	outlineOffset: '-2px'
+// @if CK_DEBUG_POSITION // };
+// @if CK_DEBUG_POSITION // const ELEMENT_RECT_STYLE = {
+// @if CK_DEBUG_POSITION // 	outlineWidth: '2px', outlineColor: 'orange', outlineOffset: '-2px'
+// @if CK_DEBUG_POSITION // };
+// @if CK_DEBUG_POSITION // const CHOSEN_POSITION_RECT_STYLE = {
+// @if CK_DEBUG_POSITION // 	opacity: .5, outlineColor: 'magenta', backgroundColor: 'magenta'
+// @if CK_DEBUG_POSITION // };
+/**
+ * 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 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 constrainedViewportRect = getConstrainedViewportRect(viewportOffsetConfig);
+    const elementRect = new Rect(element);
+    const visibleTargetRect = getVisibleViewportIntersectionRect(target, constrainedViewportRect);
+    let bestPosition;
+    // @if CK_DEBUG_POSITION // const targetRect = new Rect( target );
+    // @if CK_DEBUG_POSITION // RectDrawer.clear();
+    // @if CK_DEBUG_POSITION // RectDrawer.draw( targetRect, TARGET_RECT_STYLE, 'Target' );
+    // @if CK_DEBUG_POSITION // if ( constrainedViewportRect ) {
+    // @if CK_DEBUG_POSITION //		RectDrawer.draw( constrainedViewportRect, VIEWPORT_RECT_STYLE, 'Viewport' );
+    // @if CK_DEBUG_POSITION // }
+    // If the target got cropped by ancestors or went off the screen, positioning does not make any sense.
+    if (!visibleTargetRect || !constrainedViewportRect.getIntersection(visibleTargetRect)) {
+        return null;
+    }
+    // @if CK_DEBUG_POSITION //	RectDrawer.draw( visibleTargetRect, VISIBLE_TARGET_RECT_STYLE, 'VisTgt' );
+    const positionOptions = {
+        targetRect: visibleTargetRect,
+        elementRect,
+        positionedElementAncestor,
+        viewportRect: constrainedViewportRect
+    };
+    // If there are no limits, just grab the very first position and be done with that drama.
+    if (!limiter && !fitInViewport) {
+        bestPosition = new PositionObject(positions[0], positionOptions);
+    }
+    else {
+        if (limiter) {
+            const visibleLimiterRect = getVisibleViewportIntersectionRect(limiter, constrainedViewportRect);
+            if (visibleLimiterRect) {
+                positionOptions.limiterRect = visibleLimiterRect;
+                // @if CK_DEBUG_POSITION // RectDrawer.draw( visibleLimiterRect, VISIBLE_LIMITER_RECT_STYLE, 'VisLim' );
+            }
+        }
+        // If there's no best position found, i.e. when all intersections have no area because
+        // rects have no width or height, then just return `null`
+        bestPosition = getBestPosition(positions, positionOptions);
+    }
+    return bestPosition;
+}
+/**
+ * Returns intersection of visible source `Rect` with Viewport `Rect`. In case when source `Rect` is not visible
+ * or there is no intersection between source `Rect` and Viewport `Rect`, `null` will be returned.
+ */
+function getVisibleViewportIntersectionRect(source, viewportRect) {
+    const visibleSourceRect = new Rect(source).getVisible();
+    if (!visibleSourceRect) {
+        return null;
+    }
+    return visibleSourceRect.getIntersection(viewportRect);
+}
+/**
+ * Returns a viewport `Rect` shrunk by the viewport offset config from all sides.
+ */
+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`.
+ */
+function getBestPosition(positions, options) {
+    const { elementRect } = options;
+    // This is when element is fully visible.
+    const elementRectArea = elementRect.getArea();
+    const positionInstances = positions
+        .map(positioningFunction => new PositionObject(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) {
+            // @if CK_DEBUG_POSITION //	RectDrawer.draw( position._rect, CHOSEN_POSITION_RECT_STYLE, [
+            // @if CK_DEBUG_POSITION //		position.name,
+            // @if CK_DEBUG_POSITION //		'100% fit',
+            // @if CK_DEBUG_POSITION //	].join( '\n' ) );
+            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 CK_DEBUG_POSITION //	RectDrawer.draw( position._rect, { opacity: .4 }, [
+        // @if CK_DEBUG_POSITION //		position.name,
+        // @if CK_DEBUG_POSITION //		'Vi=' +  Math.round( viewportIntersectionArea ),
+        // @if CK_DEBUG_POSITION //		'Li=' + Math.round( limiterIntersectionArea )
+        // @if CK_DEBUG_POSITION //	].join( '\n' ) );
+        if (fitFactor > maxFitFactor) {
+            maxFitFactor = fitFactor;
+            bestPosition = position;
+        }
+    }
+    // @if CK_DEBUG_POSITION // if ( bestPosition ) {
+    // @if CK_DEBUG_POSITION // 	RectDrawer.draw( bestPosition._rect, CHOSEN_POSITION_RECT_STYLE );
+    // @if CK_DEBUG_POSITION // }
+    return bestPosition;
+}
+/**
+ * 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.
+ */
+class PositionObject {
+    /**
+     * Creates an instance of the {@link module:utils/dom/position~PositionObject} class.
+     *
+     * @param positioningFunction function The function that defines the expected
+     * coordinates the positioned element should move to.
+     * @param options options object.
+     * @param options.elementRect The positioned element rect.
+     * @param options.targetRect The target element rect.
+     * @param options.viewportRect The viewport rect.
+     * @param options.limiterRect The limiter rect.
+     * @param options.positionedElementAncestor Nearest element ancestor element which CSS position is not "static".
+     */
+    constructor(positioningFunction, options) {
+        const positioningFunctionOutput = positioningFunction(options.targetRect, options.elementRect, options.viewportRect, options.limiterRect);
+        // Nameless position for a function that didn't participate.
+        if (!positioningFunctionOutput) {
+            return;
+        }
+        const { left, top, name, config } = positioningFunctionOutput;
+        this.name = name;
+        this.config = config;
+        this._positioningFunctionCoordinates = { left, top };
+        this._options = options;
+    }
+    /**
+     * 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.
+     */
+    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.
+     */
+    get top() {
+        return this._absoluteRect.top;
+    }
+    /**
+     * An intersection area between positioned element and limiter within viewport constraints.
+     */
+    get limiterIntersectionArea() {
+        const limiterRect = this._options.limiterRect;
+        if (limiterRect) {
+            return limiterRect.getIntersectionArea(this._rect);
+        }
+        return 0;
+    }
+    /**
+     * An intersection area between positioned element and viewport.
+     */
+    get viewportIntersectionArea() {
+        const viewportRect = this._options.viewportRect;
+        return viewportRect.getIntersectionArea(this._rect);
+    }
+    /**
+     * 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.
+     */
+    get _rect() {
+        if (this._cachedRect) {
+            return this._cachedRect;
+        }
+        this._cachedRect = this._options.elementRect.clone().moveTo(this._positioningFunctionCoordinates.left, this._positioningFunctionCoordinates.top);
+        return this._cachedRect;
+    }
+    /**
+     * An already absolutely positioned element rect. See ({@link #_rect}).
+     */
+    get _absoluteRect() {
+        if (this._cachedAbsoluteRect) {
+            return this._cachedAbsoluteRect;
+        }
+        this._cachedAbsoluteRect = this._rect.toAbsoluteRect();
+        return this._cachedAbsoluteRect;
+    }
+}