@ckeditor/ckeditor5-ui 40.0.0 → 40.2.0

package/src/bindings/clickoutsidehandler.js

@@ -1,36 +1,36 @@
-/**
- * @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 document */
-/**
- * Handles clicking **outside** of a specified set of elements, then fires an action.
- *
- * **Note**: Actually, the action is executed upon `mousedown`, not `click`. It prevents
- * certain issues when the user keeps holding the mouse button and the UI cannot react
- * properly.
- *
- * @param options Configuration options.
- * @param options.emitter The emitter to which this behavior should be added.
- * @param options.activator Function returning a `Boolean`, to determine whether the handler is active.
- * @param options.contextElements Array of HTML elements or a callback returning an array of HTML elements
- * that determine the scope of the handler. Clicking any of them or their descendants will **not** fire the callback.
- * @param options.callback An action executed by the handler.
- */
-export default function clickOutsideHandler({ emitter, activator, callback, contextElements }) {
-    emitter.listenTo(document, 'mousedown', (evt, domEvt) => {
-        if (!activator()) {
-            return;
-        }
-        // Check if `composedPath` is `undefined` in case the browser does not support native shadow DOM.
-        // Can be removed when all supported browsers support native shadow DOM.
-        const path = typeof domEvt.composedPath == 'function' ? domEvt.composedPath() : [];
-        const contextElementsList = typeof contextElements == 'function' ? contextElements() : contextElements;
-        for (const contextElement of contextElementsList) {
-            if (contextElement.contains(domEvt.target) || path.includes(contextElement)) {
-                return;
-            }
-        }
-        callback();
-    });
-}
+/**
+ * @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 document */
+/**
+ * Handles clicking **outside** of a specified set of elements, then fires an action.
+ *
+ * **Note**: Actually, the action is executed upon `mousedown`, not `click`. It prevents
+ * certain issues when the user keeps holding the mouse button and the UI cannot react
+ * properly.
+ *
+ * @param options Configuration options.
+ * @param options.emitter The emitter to which this behavior should be added.
+ * @param options.activator Function returning a `Boolean`, to determine whether the handler is active.
+ * @param options.contextElements Array of HTML elements or a callback returning an array of HTML elements
+ * that determine the scope of the handler. Clicking any of them or their descendants will **not** fire the callback.
+ * @param options.callback An action executed by the handler.
+ */
+export default function clickOutsideHandler({ emitter, activator, callback, contextElements }) {
+    emitter.listenTo(document, 'mousedown', (evt, domEvt) => {
+        if (!activator()) {
+            return;
+        }
+        // Check if `composedPath` is `undefined` in case the browser does not support native shadow DOM.
+        // Can be removed when all supported browsers support native shadow DOM.
+        const path = typeof domEvt.composedPath == 'function' ? domEvt.composedPath() : [];
+        const contextElementsList = typeof contextElements == 'function' ? contextElements() : contextElements;
+        for (const contextElement of contextElementsList) {
+            if (contextElement.contains(domEvt.target) || path.includes(contextElement)) {
+                return;
+            }
+        }
+        callback();
+    });
+}

package/src/bindings/csstransitiondisablermixin.d.ts

@@ -1,40 +1,40 @@
-/**
- * @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 ui/bindings/csstransitiondisablermixin
- */
-import type { Constructor, Mixed } from '@ckeditor/ckeditor5-utils';
-import type View from '../view';
-/**
- * A mixin that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * The usage comes down to:
- *
- * ```ts
- * const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
- * const view = new MyViewWithCssTransitionDisabler();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @param view View instance that should get this functionality.
- */
-export default function CssTransitionDisablerMixin<Base extends Constructor<View>>(view: Base): Mixed<Base, ViewWithCssTransitionDisabler>;
-export type ViewWithCssTransitionDisabler = View & {
-    disableCssTransitions(): void;
-    enableCssTransitions(): void;
-};
+/**
+ * @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 ui/bindings/csstransitiondisablermixin
+ */
+import type { Constructor, Mixed } from '@ckeditor/ckeditor5-utils';
+import type View from '../view';
+/**
+ * A mixin that brings the possibility to temporarily disable CSS transitions using
+ * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
+ * when the view is first displayed but they should work normal in other cases.
+ *
+ * The methods to control the CSS transitions are:
+ * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
+ * {@link module:ui/view~View#element view element}.
+ * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
+ * {@link module:ui/view~View#element view element}.
+ *
+ * The usage comes down to:
+ *
+ * ```ts
+ * const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
+ * const view = new MyViewWithCssTransitionDisabler();
+ *
+ * // ...
+ *
+ * view.disableCssTransitions();
+ * view.show();
+ * view.enableCssTransitions();
+ * ```
+ *
+ * @param view View instance that should get this functionality.
+ */
+export default function CssTransitionDisablerMixin<Base extends Constructor<View>>(view: Base): Mixed<Base, ViewWithCssTransitionDisabler>;
+export type ViewWithCssTransitionDisabler = View & {
+    disableCssTransitions(): void;
+    enableCssTransitions(): void;
+};

package/src/bindings/csstransitiondisablermixin.js

@@ -1,55 +1,55 @@
-/**
- * @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
- */
-/**
- * A mixin that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * The usage comes down to:
- *
- * ```ts
- * const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
- * const view = new MyViewWithCssTransitionDisabler();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @param view View instance that should get this functionality.
- */
-export default function CssTransitionDisablerMixin(view) {
-    class Mixin extends view {
-        disableCssTransitions() {
-            this._isCssTransitionsDisabled = true;
-        }
-        enableCssTransitions() {
-            this._isCssTransitionsDisabled = false;
-        }
-        constructor(...args) {
-            super(...args);
-            this.set('_isCssTransitionsDisabled', false);
-            this.initializeCssTransitionDisablerMixin();
-        }
-        initializeCssTransitionDisablerMixin() {
-            this.extendTemplate({
-                attributes: {
-                    class: [
-                        this.bindTemplate.if('_isCssTransitionsDisabled', 'ck-transitions-disabled')
-                    ]
-                }
-            });
-        }
-    }
-    return Mixin;
-}
+/**
+ * @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
+ */
+/**
+ * A mixin that brings the possibility to temporarily disable CSS transitions using
+ * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
+ * when the view is first displayed but they should work normal in other cases.
+ *
+ * The methods to control the CSS transitions are:
+ * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
+ * {@link module:ui/view~View#element view element}.
+ * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
+ * {@link module:ui/view~View#element view element}.
+ *
+ * The usage comes down to:
+ *
+ * ```ts
+ * const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
+ * const view = new MyViewWithCssTransitionDisabler();
+ *
+ * // ...
+ *
+ * view.disableCssTransitions();
+ * view.show();
+ * view.enableCssTransitions();
+ * ```
+ *
+ * @param view View instance that should get this functionality.
+ */
+export default function CssTransitionDisablerMixin(view) {
+    class Mixin extends view {
+        disableCssTransitions() {
+            this._isCssTransitionsDisabled = true;
+        }
+        enableCssTransitions() {
+            this._isCssTransitionsDisabled = false;
+        }
+        constructor(...args) {
+            super(...args);
+            this.set('_isCssTransitionsDisabled', false);
+            this.initializeCssTransitionDisablerMixin();
+        }
+        initializeCssTransitionDisablerMixin() {
+            this.extendTemplate({
+                attributes: {
+                    class: [
+                        this.bindTemplate.if('_isCssTransitionsDisabled', 'ck-transitions-disabled')
+                    ]
+                }
+            });
+        }
+    }
+    return Mixin;
+}

package/src/bindings/injectcsstransitiondisabler.d.ts

@@ -1,59 +1,59 @@
-/**
- * @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 ui/bindings/injectcsstransitiondisabler
- */
-import type View from '../view';
-/**
- * A decorator that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
- * {@link module:ui/view~View#setTemplate} is called:
- *
- * ```ts
- * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
- *
- * class MyView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		this.setTemplate( { ... } );
- *
- * 		// ...
- *
- * 		injectCssTransitionDisabler( this );
- *
- * 		// ...
- * 	}
- * }
- * ```
- *
- * The usage comes down to:
- *
- * ```ts
- * const view = new MyView();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @deprecated
- * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
- * @param view View instance that should get this functionality.
- */
-export default function injectCssTransitionDisabler(view: View): void;
+/**
+ * @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 ui/bindings/injectcsstransitiondisabler
+ */
+import type View from '../view';
+/**
+ * A decorator that brings the possibility to temporarily disable CSS transitions using
+ * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
+ * when the view is first displayed but they should work normal in other cases.
+ *
+ * The methods to control the CSS transitions are:
+ * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
+ * {@link module:ui/view~View#element view element}.
+ * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
+ * {@link module:ui/view~View#element view element}.
+ *
+ * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
+ * {@link module:ui/view~View#setTemplate} is called:
+ *
+ * ```ts
+ * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
+ *
+ * class MyView extends View {
+ * 	constructor() {
+ * 		super();
+ *
+ * 		// ...
+ *
+ * 		this.setTemplate( { ... } );
+ *
+ * 		// ...
+ *
+ * 		injectCssTransitionDisabler( this );
+ *
+ * 		// ...
+ * 	}
+ * }
+ * ```
+ *
+ * The usage comes down to:
+ *
+ * ```ts
+ * const view = new MyView();
+ *
+ * // ...
+ *
+ * view.disableCssTransitions();
+ * view.show();
+ * view.enableCssTransitions();
+ * ```
+ *
+ * @deprecated
+ * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
+ * @param view View instance that should get this functionality.
+ */
+export default function injectCssTransitionDisabler(view: View): void;

package/src/bindings/injectcsstransitiondisabler.js

@@ -1,71 +1,71 @@
-/**
- * @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
- */
-/**
- * A decorator that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
- * {@link module:ui/view~View#setTemplate} is called:
- *
- * ```ts
- * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
- *
- * class MyView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		this.setTemplate( { ... } );
- *
- * 		// ...
- *
- * 		injectCssTransitionDisabler( this );
- *
- * 		// ...
- * 	}
- * }
- * ```
- *
- * The usage comes down to:
- *
- * ```ts
- * const view = new MyView();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @deprecated
- * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
- * @param view View instance that should get this functionality.
- */
-export default function injectCssTransitionDisabler(view) {
-    const decorated = view;
-    decorated.set('_isCssTransitionsDisabled', false);
-    decorated.disableCssTransitions = () => {
-        decorated._isCssTransitionsDisabled = true;
-    };
-    decorated.enableCssTransitions = () => {
-        decorated._isCssTransitionsDisabled = false;
-    };
-    decorated.extendTemplate({
-        attributes: {
-            class: [
-                decorated.bindTemplate.if('_isCssTransitionsDisabled', 'ck-transitions-disabled')
-            ]
-        }
-    });
-}
+/**
+ * @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
+ */
+/**
+ * A decorator that brings the possibility to temporarily disable CSS transitions using
+ * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
+ * when the view is first displayed but they should work normal in other cases.
+ *
+ * The methods to control the CSS transitions are:
+ * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
+ * {@link module:ui/view~View#element view element}.
+ * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
+ * {@link module:ui/view~View#element view element}.
+ *
+ * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
+ * {@link module:ui/view~View#setTemplate} is called:
+ *
+ * ```ts
+ * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
+ *
+ * class MyView extends View {
+ * 	constructor() {
+ * 		super();
+ *
+ * 		// ...
+ *
+ * 		this.setTemplate( { ... } );
+ *
+ * 		// ...
+ *
+ * 		injectCssTransitionDisabler( this );
+ *
+ * 		// ...
+ * 	}
+ * }
+ * ```
+ *
+ * The usage comes down to:
+ *
+ * ```ts
+ * const view = new MyView();
+ *
+ * // ...
+ *
+ * view.disableCssTransitions();
+ * view.show();
+ * view.enableCssTransitions();
+ * ```
+ *
+ * @deprecated
+ * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
+ * @param view View instance that should get this functionality.
+ */
+export default function injectCssTransitionDisabler(view) {
+    const decorated = view;
+    decorated.set('_isCssTransitionsDisabled', false);
+    decorated.disableCssTransitions = () => {
+        decorated._isCssTransitionsDisabled = true;
+    };
+    decorated.enableCssTransitions = () => {
+        decorated._isCssTransitionsDisabled = false;
+    };
+    decorated.extendTemplate({
+        attributes: {
+            class: [
+                decorated.bindTemplate.if('_isCssTransitionsDisabled', 'ck-transitions-disabled')
+            ]
+        }
+    });
+}

package/src/bindings/preventdefault.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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 ui/bindings/preventdefault
- */
-import type { ListenerBinding } from '../template';
-import type View from '../view';
-/**
- * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
- * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
- * {@link module:ui/view~View#template template}.
- *
- * ```ts
- * // In a class extending View.
- * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
- *
- * // ...
- *
- * this.setTemplate( {
- * 	tag: 'div',
- *
- * 	on: {
- * 		// Prevent the default mousedown action on this view.
- * 		mousedown: preventDefault( this )
- * 	}
- * } );
- * ```
- *
- * @param view View instance that defines the template.
- */
-export default function preventDefault(view: View): ListenerBinding;
+/**
+ * @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 ui/bindings/preventdefault
+ */
+import type { ListenerBinding } from '../template';
+import type View from '../view';
+/**
+ * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
+ * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
+ * {@link module:ui/view~View#template template}.
+ *
+ * ```ts
+ * // In a class extending View.
+ * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
+ *
+ * // ...
+ *
+ * this.setTemplate( {
+ * 	tag: 'div',
+ *
+ * 	on: {
+ * 		// Prevent the default mousedown action on this view.
+ * 		mousedown: preventDefault( this )
+ * 	}
+ * } );
+ * ```
+ *
+ * @param view View instance that defines the template.
+ */
+export default function preventDefault(view: View): ListenerBinding;

package/src/bindings/preventdefault.js

@@ -1,34 +1,34 @@
-/**
- * @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
- */
-/**
- * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
- * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
- * {@link module:ui/view~View#template template}.
- *
- * ```ts
- * // In a class extending View.
- * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
- *
- * // ...
- *
- * this.setTemplate( {
- * 	tag: 'div',
- *
- * 	on: {
- * 		// Prevent the default mousedown action on this view.
- * 		mousedown: preventDefault( this )
- * 	}
- * } );
- * ```
- *
- * @param view View instance that defines the template.
- */
-export default function preventDefault(view) {
-    return view.bindTemplate.to(evt => {
-        if (evt.target === view.element) {
-            evt.preventDefault();
-        }
-    });
-}
+/**
+ * @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
+ */
+/**
+ * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
+ * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
+ * {@link module:ui/view~View#template template}.
+ *
+ * ```ts
+ * // In a class extending View.
+ * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
+ *
+ * // ...
+ *
+ * this.setTemplate( {
+ * 	tag: 'div',
+ *
+ * 	on: {
+ * 		// Prevent the default mousedown action on this view.
+ * 		mousedown: preventDefault( this )
+ * 	}
+ * } );
+ * ```
+ *
+ * @param view View instance that defines the template.
+ */
+export default function preventDefault(view) {
+    return view.bindTemplate.to(evt => {
+        if (evt.target === view.element) {
+            evt.preventDefault();
+        }
+    });
+}