@ckeditor/ckeditor5-utils 40.0.0 → 40.2.0

package/src/focustracker.d.ts

@@ -1,75 +1,75 @@
-/**
- * @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
- */
-declare const FocusTracker_base: import("./mix").Mixed<{
-    new (): import("./observablemixin").Observable;
-    prototype: import("./observablemixin").Observable;
-}, import("./dom/emittermixin").DomEmitter>;
-/**
- * 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 `Element`
- * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
- * (have e.g. `tabindex="-1"`).
- *
- * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
- */
-export default class FocusTracker extends FocusTracker_base {
-    /**
-     * True when one of the registered elements is focused.
-     *
-     * @readonly
-     * @observable
-     */
-    isFocused: boolean;
-    /**
-     * 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
-     */
-    focusedElement: Element | null;
-    /**
-     * List of registered elements.
-     *
-     * @internal
-     */
-    _elements: Set<Element>;
-    /**
-     * Event loop timeout.
-     */
-    private _nextEventLoopTimeout;
-    constructor();
-    /**
-     * Starts tracking the specified element.
-     */
-    add(element: Element): void;
-    /**
-     * Stops tracking the specified element and stops listening on this element.
-     */
-    remove(element: Element): void;
-    /**
-     * Destroys the focus tracker by:
-     * - Disabling all event listeners attached to tracked elements.
-     * - Removing all tracked elements that were previously added.
-     */
-    destroy(): void;
-    /**
-     * Stores currently focused element and set {@link #isFocused} as `true`.
-     */
-    private _focus;
-    /**
-     * Clears currently focused element and set {@link #isFocused} as `false`.
-     * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
-     */
-    private _blur;
-}
-export {};
+/**
+ * @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
+ */
+declare const FocusTracker_base: import("./mix").Mixed<{
+    new (): import("./observablemixin").Observable;
+    prototype: import("./observablemixin").Observable;
+}, import("./dom/emittermixin").DomEmitter>;
+/**
+ * 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 `Element`
+ * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
+ * (have e.g. `tabindex="-1"`).
+ *
+ * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
+ */
+export default class FocusTracker extends FocusTracker_base {
+    /**
+     * True when one of the registered elements is focused.
+     *
+     * @readonly
+     * @observable
+     */
+    isFocused: boolean;
+    /**
+     * 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
+     */
+    focusedElement: Element | null;
+    /**
+     * List of registered elements.
+     *
+     * @internal
+     */
+    _elements: Set<Element>;
+    /**
+     * Event loop timeout.
+     */
+    private _nextEventLoopTimeout;
+    constructor();
+    /**
+     * Starts tracking the specified element.
+     */
+    add(element: Element): void;
+    /**
+     * Stops tracking the specified element and stops listening on this element.
+     */
+    remove(element: Element): void;
+    /**
+     * Destroys the focus tracker by:
+     * - Disabling all event listeners attached to tracked elements.
+     * - Removing all tracked elements that were previously added.
+     */
+    destroy(): void;
+    /**
+     * Stores currently focused element and set {@link #isFocused} as `true`.
+     */
+    private _focus;
+    /**
+     * Clears currently focused element and set {@link #isFocused} as `false`.
+     * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
+     */
+    private _blur;
+}
+export {};

package/src/focustracker.js

@@ -1,95 +1,95 @@
-/**
- * @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
- */
-/* global setTimeout, clearTimeout */
-/**
- * @module utils/focustracker
- */
-import DomEmitterMixin from './dom/emittermixin';
-import ObservableMixin from './observablemixin';
-import CKEditorError from './ckeditorerror';
-/**
- * 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 `Element`
- * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
- * (have e.g. `tabindex="-1"`).
- *
- * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
- */
-export default class FocusTracker extends DomEmitterMixin(ObservableMixin()) {
-    constructor() {
-        super();
-        /**
-         * List of registered elements.
-         *
-         * @internal
-         */
-        this._elements = new Set();
-        /**
-         * Event loop timeout.
-         */
-        this._nextEventLoopTimeout = null;
-        this.set('isFocused', false);
-        this.set('focusedElement', null);
-    }
-    /**
-     * Starts tracking the specified 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.
-     */
-    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 {@link #isFocused} as `true`.
-     */
-    _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.
-     */
-    _blur() {
-        clearTimeout(this._nextEventLoopTimeout);
-        this._nextEventLoopTimeout = setTimeout(() => {
-            this.focusedElement = null;
-            this.isFocused = false;
-        }, 0);
-    }
-}
+/**
+ * @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
+ */
+/* global setTimeout, clearTimeout */
+/**
+ * @module utils/focustracker
+ */
+import DomEmitterMixin from './dom/emittermixin';
+import ObservableMixin from './observablemixin';
+import CKEditorError from './ckeditorerror';
+/**
+ * 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 `Element`
+ * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
+ * (have e.g. `tabindex="-1"`).
+ *
+ * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
+ */
+export default class FocusTracker extends DomEmitterMixin(ObservableMixin()) {
+    constructor() {
+        super();
+        /**
+         * List of registered elements.
+         *
+         * @internal
+         */
+        this._elements = new Set();
+        /**
+         * Event loop timeout.
+         */
+        this._nextEventLoopTimeout = null;
+        this.set('isFocused', false);
+        this.set('focusedElement', null);
+    }
+    /**
+     * Starts tracking the specified 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.
+     */
+    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 {@link #isFocused} as `true`.
+     */
+    _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.
+     */
+    _blur() {
+        clearTimeout(this._nextEventLoopTimeout);
+        this._nextEventLoopTimeout = setTimeout(() => {
+            this.focusedElement = null;
+            this.isFocused = false;
+        }, 0);
+    }
+}

package/src/index.d.ts

@@ -1,61 +1,64 @@
-/**
- * @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
- */
-/**
- * @module utils
- */
-export { default as env } from './env';
-export { default as diff, type DiffResult } from './diff';
-export { default as fastDiff } from './fastdiff';
-export { default as diffToChanges } from './difftochanges';
-export { default as mix } from './mix';
-export type { Constructor, Mixed } from './mix';
-export { default as EmitterMixin, type Emitter, type BaseEvent, type CallbackOptions, type EmitterMixinDelegateChain, type GetCallback, type GetCallbackOptions, type GetEventInfo, type GetNameOrEventInfo } from './emittermixin';
-export { default as EventInfo } from './eventinfo';
-export { default as ObservableMixin, type Observable, type DecoratedMethodEvent, type ObservableChangeEvent, type ObservableSetEvent } from './observablemixin';
-export { default as CKEditorError, logError, logWarning } from './ckeditorerror';
-export { default as ElementReplacer } from './elementreplacer';
-export { default as count } from './count';
-export { default as compareArrays } from './comparearrays';
-export { default as createElement } from './dom/createelement';
-export { default as Config } from './config';
-export { default as isIterable } from './isiterable';
-export { default as DomEmitterMixin, type DomEmitter } from './dom/emittermixin';
-export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor';
-export { default as global } from './dom/global';
-export { default as getAncestors } from './dom/getancestors';
-export { default as getDataFromElement } from './dom/getdatafromelement';
-export { default as getBorderWidths } from './dom/getborderwidths';
-export { default as isText } from './dom/istext';
-export { default as Rect, type RectSource } from './dom/rect';
-export { default as ResizeObserver } from './dom/resizeobserver';
-export { default as setDataInElement } from './dom/setdatainelement';
-export { default as toUnit } from './dom/tounit';
-export { default as indexOf } from './dom/indexof';
-export { default as insertAt } from './dom/insertat';
-export { default as isComment } from './dom/iscomment';
-export { default as isNode } from './dom/isnode';
-export { default as isRange } from './dom/isrange';
-export { default as isValidAttributeName } from './dom/isvalidattributename';
-export { default as isVisible } from './dom/isvisible';
-export { getOptimalPosition, type Options as PositionOptions, type PositioningFunction, type Position } from './dom/position';
-export { default as remove } from './dom/remove';
-export * from './dom/scroll';
-export * from './keyboard';
-export * from './language';
-export { default as Locale, type LocaleTranslate } from './locale';
-export { default as Collection, type CollectionAddEvent, type CollectionChangeEvent, type CollectionRemoveEvent } from './collection';
-export { default as first } from './first';
-export { default as FocusTracker } from './focustracker';
-export { default as KeystrokeHandler } from './keystrokehandler';
-export { default as toArray, type ArrayOrItem, type ReadonlyArrayOrItem } from './toarray';
-export { default as toMap } from './tomap';
-export { default as priorities, type PriorityString } from './priorities';
-export { default as insertToPriorityArray } from './inserttopriorityarray';
-export { default as spliceArray } from './splicearray';
-export { default as uid } from './uid';
-export { default as delay, type DelayedFunc } from './delay';
-export { default as verifyLicense } from './verifylicense';
-export * from './unicode';
-export { default as version, releaseDate } from './version';
+/**
+ * @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
+ */
+/**
+ * @module utils
+ */
+export { default as env } from './env';
+export { default as diff, type DiffResult } from './diff';
+export { default as fastDiff } from './fastdiff';
+export { default as diffToChanges } from './difftochanges';
+export { default as mix } from './mix';
+export type { Constructor, Mixed } from './mix';
+export { default as EmitterMixin, type Emitter, type BaseEvent, type CallbackOptions, type EmitterMixinDelegateChain, type GetCallback, type GetCallbackOptions, type GetEventInfo, type GetNameOrEventInfo } from './emittermixin';
+export { default as EventInfo } from './eventinfo';
+export { default as ObservableMixin, type Observable, type DecoratedMethodEvent, type ObservableChangeEvent, type ObservableSetEvent } from './observablemixin';
+export { default as CKEditorError, logError, logWarning } from './ckeditorerror';
+export { default as ElementReplacer } from './elementreplacer';
+export { default as abortableDebounce, type AbortableFunc } from './abortabledebounce';
+export { default as count } from './count';
+export { default as compareArrays } from './comparearrays';
+export { default as createElement } from './dom/createelement';
+export { default as Config } from './config';
+export { default as isIterable } from './isiterable';
+export { default as DomEmitterMixin, type DomEmitter } from './dom/emittermixin';
+export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor';
+export { default as global } from './dom/global';
+export { default as getAncestors } from './dom/getancestors';
+export { default as getDataFromElement } from './dom/getdatafromelement';
+export { default as getBorderWidths } from './dom/getborderwidths';
+export { default as isText } from './dom/istext';
+export { default as Rect, type RectSource } from './dom/rect';
+export { default as ResizeObserver } from './dom/resizeobserver';
+export { default as setDataInElement } from './dom/setdatainelement';
+export { default as toUnit } from './dom/tounit';
+export { default as indexOf } from './dom/indexof';
+export { default as insertAt } from './dom/insertat';
+export { default as isComment } from './dom/iscomment';
+export { default as isNode } from './dom/isnode';
+export { default as isRange } from './dom/isrange';
+export { default as isValidAttributeName } from './dom/isvalidattributename';
+export { default as isVisible } from './dom/isvisible';
+export { getOptimalPosition, type Options as PositionOptions, type PositioningFunction, type Position } from './dom/position';
+export { default as remove } from './dom/remove';
+export * from './dom/scroll';
+export * from './keyboard';
+export * from './language';
+export { default as Locale, type LocaleTranslate } from './locale';
+export { default as Collection, type CollectionAddEvent, type CollectionChangeEvent, type CollectionRemoveEvent } from './collection';
+export { default as first } from './first';
+export { default as FocusTracker } from './focustracker';
+export { default as KeystrokeHandler } from './keystrokehandler';
+export { default as toArray, type ArrayOrItem, type ReadonlyArrayOrItem } from './toarray';
+export { default as toMap } from './tomap';
+export { default as priorities, type PriorityString } from './priorities';
+export { default as retry, exponentialDelay } from './retry';
+export { default as insertToPriorityArray } from './inserttopriorityarray';
+export { default as spliceArray } from './splicearray';
+export { default as uid } from './uid';
+export { default as delay, type DelayedFunc } from './delay';
+export { default as verifyLicense } from './verifylicense';
+export { default as wait } from './wait';
+export * from './unicode';
+export { default as version, releaseDate } from './version';

package/src/index.js

@@ -1,60 +1,63 @@
-/**
- * @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
- */
-/**
- * @module utils
- */
-export { default as env } from './env';
-export { default as diff } from './diff';
-export { default as fastDiff } from './fastdiff';
-export { default as diffToChanges } from './difftochanges';
-export { default as mix } from './mix';
-export { default as EmitterMixin } from './emittermixin';
-export { default as EventInfo } from './eventinfo';
-export { default as ObservableMixin } from './observablemixin';
-export { default as CKEditorError, logError, logWarning } from './ckeditorerror';
-export { default as ElementReplacer } from './elementreplacer';
-export { default as count } from './count';
-export { default as compareArrays } from './comparearrays';
-export { default as createElement } from './dom/createelement';
-export { default as Config } from './config';
-export { default as isIterable } from './isiterable';
-export { default as DomEmitterMixin } from './dom/emittermixin';
-export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor';
-export { default as global } from './dom/global';
-export { default as getAncestors } from './dom/getancestors';
-export { default as getDataFromElement } from './dom/getdatafromelement';
-export { default as getBorderWidths } from './dom/getborderwidths';
-export { default as isText } from './dom/istext';
-export { default as Rect } from './dom/rect';
-export { default as ResizeObserver } from './dom/resizeobserver';
-export { default as setDataInElement } from './dom/setdatainelement';
-export { default as toUnit } from './dom/tounit';
-export { default as indexOf } from './dom/indexof';
-export { default as insertAt } from './dom/insertat';
-export { default as isComment } from './dom/iscomment';
-export { default as isNode } from './dom/isnode';
-export { default as isRange } from './dom/isrange';
-export { default as isValidAttributeName } from './dom/isvalidattributename';
-export { default as isVisible } from './dom/isvisible';
-export { getOptimalPosition } from './dom/position';
-export { default as remove } from './dom/remove';
-export * from './dom/scroll';
-export * from './keyboard';
-export * from './language';
-export { default as Locale } from './locale';
-export { default as Collection } from './collection';
-export { default as first } from './first';
-export { default as FocusTracker } from './focustracker';
-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 insertToPriorityArray } from './inserttopriorityarray';
-export { default as spliceArray } from './splicearray';
-export { default as uid } from './uid';
-export { default as delay } from './delay';
-export { default as verifyLicense } from './verifylicense';
-export * from './unicode';
-export { default as version, releaseDate } from './version';
+/**
+ * @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
+ */
+/**
+ * @module utils
+ */
+export { default as env } from './env';
+export { default as diff } from './diff';
+export { default as fastDiff } from './fastdiff';
+export { default as diffToChanges } from './difftochanges';
+export { default as mix } from './mix';
+export { default as EmitterMixin } from './emittermixin';
+export { default as EventInfo } from './eventinfo';
+export { default as ObservableMixin } from './observablemixin';
+export { default as CKEditorError, logError, logWarning } from './ckeditorerror';
+export { default as ElementReplacer } from './elementreplacer';
+export { default as abortableDebounce } from './abortabledebounce';
+export { default as count } from './count';
+export { default as compareArrays } from './comparearrays';
+export { default as createElement } from './dom/createelement';
+export { default as Config } from './config';
+export { default as isIterable } from './isiterable';
+export { default as DomEmitterMixin } from './dom/emittermixin';
+export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor';
+export { default as global } from './dom/global';
+export { default as getAncestors } from './dom/getancestors';
+export { default as getDataFromElement } from './dom/getdatafromelement';
+export { default as getBorderWidths } from './dom/getborderwidths';
+export { default as isText } from './dom/istext';
+export { default as Rect } from './dom/rect';
+export { default as ResizeObserver } from './dom/resizeobserver';
+export { default as setDataInElement } from './dom/setdatainelement';
+export { default as toUnit } from './dom/tounit';
+export { default as indexOf } from './dom/indexof';
+export { default as insertAt } from './dom/insertat';
+export { default as isComment } from './dom/iscomment';
+export { default as isNode } from './dom/isnode';
+export { default as isRange } from './dom/isrange';
+export { default as isValidAttributeName } from './dom/isvalidattributename';
+export { default as isVisible } from './dom/isvisible';
+export { getOptimalPosition } from './dom/position';
+export { default as remove } from './dom/remove';
+export * from './dom/scroll';
+export * from './keyboard';
+export * from './language';
+export { default as Locale } from './locale';
+export { default as Collection } from './collection';
+export { default as first } from './first';
+export { default as FocusTracker } from './focustracker';
+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 retry, exponentialDelay } from './retry';
+export { default as insertToPriorityArray } from './inserttopriorityarray';
+export { default as spliceArray } from './splicearray';
+export { default as uid } from './uid';
+export { default as delay } from './delay';
+export { default as verifyLicense } from './verifylicense';
+export { default as wait } from './wait';
+export * from './unicode';
+export { default as version, releaseDate } from './version';