@ckeditor/ckeditor5-ui 39.0.1 → 40.0.0

package/src/viewcollection.js

@@ -1,206 +1,206 @@
-/**
- * @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/viewcollection
- */
-import { CKEditorError, Collection } from '@ckeditor/ckeditor5-utils';
-/**
- * Collects {@link module:ui/view~View} instances.
- *
- * ```ts
- * const parentView = new ParentView( locale );
- * const collection = new ViewCollection( locale );
- *
- * collection.setParent( parentView.element );
- *
- * const viewA = new ChildView( locale );
- * const viewB = new ChildView( locale );
- * ```
- *
- * View collection renders and manages view {@link module:ui/view~View#element elements}:
- *
- * ```ts
- * collection.add( viewA );
- * collection.add( viewB );
- *
- * console.log( parentView.element.firsChild ); // -> viewA.element
- * console.log( parentView.element.lastChild ); // -> viewB.element
- * ```
- *
- * It {@link module:ui/viewcollection~ViewCollection#delegate propagates} DOM events too:
- *
- * ```ts
- * // Delegate #click and #keydown events from viewA and viewB to the parentView.
- * collection.delegate( 'click' ).to( parentView );
- *
- * parentView.on( 'click', ( evt ) => {
- * 	console.log( `${ evt.source } has been clicked.` );
- * } );
- *
- * // This event will be delegated to the parentView.
- * viewB.fire( 'click' );
- * ```
- *
- * **Note**: A view collection can be used directly in the {@link module:ui/template~TemplateDefinition definition}
- * of a {@link module:ui/template~Template template}.
- */
-export default class ViewCollection extends Collection {
-    /**
-     * Creates a new instance of the {@link module:ui/viewcollection~ViewCollection}.
-     *
-     * @param initialItems The initial items of the collection.
-     */
-    constructor(initialItems = []) {
-        super(initialItems, {
-            // An #id Number attribute should be legal and not break the `ViewCollection` instance.
-            // https://github.com/ckeditor/ckeditor5-ui/issues/93
-            idProperty: 'viewUid'
-        });
-        // Handle {@link module:ui/view~View#element} in DOM when a new view is added to the collection.
-        this.on('add', (evt, view, index) => {
-            this._renderViewIntoCollectionParent(view, index);
-        });
-        // Handle {@link module:ui/view~View#element} in DOM when a view is removed from the collection.
-        this.on('remove', (evt, view) => {
-            if (view.element && this._parentElement) {
-                view.element.remove();
-            }
-        });
-        this._parentElement = null;
-    }
-    /**
-     * Destroys the view collection along with child views.
-     * See the view {@link module:ui/view~View#destroy} method.
-     */
-    destroy() {
-        this.map(view => view.destroy());
-    }
-    /**
-     * Sets the parent HTML element of this collection. When parent is set, {@link #add adding} and
-     * {@link #remove removing} views in the collection synchronizes their
-     * {@link module:ui/view~View#element elements} in the parent element.
-     *
-     * @param element A new parent element.
-     */
-    setParent(elementOrDocFragment) {
-        this._parentElement = elementOrDocFragment;
-        // Take care of the initial collection items passed to the constructor.
-        for (const view of this) {
-            this._renderViewIntoCollectionParent(view);
-        }
-    }
-    /**
-     * Delegates selected events coming from within views in the collection to any
-     * {@link module:utils/emittermixin~Emitter}.
-     *
-     * For the following views and collection:
-     *
-     * ```ts
-     * const viewA = new View();
-     * const viewB = new View();
-     * const viewC = new View();
-     *
-     * const views = parentView.createCollection();
-     *
-     * views.delegate( 'eventX' ).to( viewB );
-     * views.delegate( 'eventX', 'eventY' ).to( viewC );
-     *
-     * views.add( viewA );
-     * ```
-     *
-     * the `eventX` is delegated (fired by) `viewB` and `viewC` along with `customData`:
-     *
-     * ```ts
-     * viewA.fire( 'eventX', customData );
-     * ```
-     *
-     * and `eventY` is delegated (fired by) `viewC` along with `customData`:
-     *
-     * ```ts
-     * viewA.fire( 'eventY', customData );
-     * ```
-     *
-     * See {@link module:utils/emittermixin~Emitter#delegate}.
-     *
-     * @param events {@link module:ui/view~View} event names to be delegated to another
-     * {@link module:utils/emittermixin~Emitter}.
-     * @returns Object with `to` property, a function which accepts the destination
-     * of {@link module:utils/emittermixin~Emitter#delegate delegated} events.
-     */
-    delegate(...events) {
-        if (!events.length || !isStringArray(events)) {
-            /**
-             * All event names must be strings.
-             *
-             * @error ui-viewcollection-delegate-wrong-events
-             */
-            throw new CKEditorError('ui-viewcollection-delegate-wrong-events', this);
-        }
-        return {
-            to: dest => {
-                // Activate delegating on existing views in this collection.
-                for (const view of this) {
-                    for (const evtName of events) {
-                        view.delegate(evtName).to(dest);
-                    }
-                }
-                // Activate delegating on future views in this collection.
-                this.on('add', (evt, view) => {
-                    for (const evtName of events) {
-                        view.delegate(evtName).to(dest);
-                    }
-                });
-                // Deactivate delegating when view is removed from this collection.
-                this.on('remove', (evt, view) => {
-                    for (const evtName of events) {
-                        view.stopDelegating(evtName, dest);
-                    }
-                });
-            }
-        };
-    }
-    /**
-     * This method {@link module:ui/view~View#render renders} a new view added to the collection.
-     *
-     * If the {@link #_parentElement parent element} of the collection is set, this method also adds
-     * the view's {@link module:ui/view~View#element} as a child of the parent in DOM at a specified index.
-     *
-     * **Note**: If index is not specified, the view's element is pushed as the last child
-     * of the parent element.
-     *
-     * @param view A new view added to the collection.
-     * @param index An index the view holds in the collection. When not specified,
-     * the view is added at the end.
-     */
-    _renderViewIntoCollectionParent(view, index) {
-        if (!view.isRendered) {
-            view.render();
-        }
-        if (view.element && this._parentElement) {
-            this._parentElement.insertBefore(view.element, this._parentElement.children[index]);
-        }
-    }
-    /**
-     * Removes a child view from the collection. If the {@link #setParent parent element} of the
-     * collection has been set, the {@link module:ui/view~View#element element} of the view is also removed
-     * in DOM, reflecting the order of the collection.
-     *
-     * See the {@link #add} method.
-     *
-     * @param subject The view to remove, its id or index in the collection.
-     * @returns The removed view.
-     */
-    remove(subject) {
-        return super.remove(subject);
-    }
-}
-/**
- * Check if all entries of the array are of `String` type.
- *
- * @param arr An array to be checked.
- */
-function isStringArray(arr) {
-    return arr.every(a => typeof a == 'string');
-}
+/**
+ * @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/viewcollection
+ */
+import { CKEditorError, Collection } from '@ckeditor/ckeditor5-utils';
+/**
+ * Collects {@link module:ui/view~View} instances.
+ *
+ * ```ts
+ * const parentView = new ParentView( locale );
+ * const collection = new ViewCollection( locale );
+ *
+ * collection.setParent( parentView.element );
+ *
+ * const viewA = new ChildView( locale );
+ * const viewB = new ChildView( locale );
+ * ```
+ *
+ * View collection renders and manages view {@link module:ui/view~View#element elements}:
+ *
+ * ```ts
+ * collection.add( viewA );
+ * collection.add( viewB );
+ *
+ * console.log( parentView.element.firsChild ); // -> viewA.element
+ * console.log( parentView.element.lastChild ); // -> viewB.element
+ * ```
+ *
+ * It {@link module:ui/viewcollection~ViewCollection#delegate propagates} DOM events too:
+ *
+ * ```ts
+ * // Delegate #click and #keydown events from viewA and viewB to the parentView.
+ * collection.delegate( 'click' ).to( parentView );
+ *
+ * parentView.on( 'click', ( evt ) => {
+ * 	console.log( `${ evt.source } has been clicked.` );
+ * } );
+ *
+ * // This event will be delegated to the parentView.
+ * viewB.fire( 'click' );
+ * ```
+ *
+ * **Note**: A view collection can be used directly in the {@link module:ui/template~TemplateDefinition definition}
+ * of a {@link module:ui/template~Template template}.
+ */
+export default class ViewCollection extends Collection {
+    /**
+     * Creates a new instance of the {@link module:ui/viewcollection~ViewCollection}.
+     *
+     * @param initialItems The initial items of the collection.
+     */
+    constructor(initialItems = []) {
+        super(initialItems, {
+            // An #id Number attribute should be legal and not break the `ViewCollection` instance.
+            // https://github.com/ckeditor/ckeditor5-ui/issues/93
+            idProperty: 'viewUid'
+        });
+        // Handle {@link module:ui/view~View#element} in DOM when a new view is added to the collection.
+        this.on('add', (evt, view, index) => {
+            this._renderViewIntoCollectionParent(view, index);
+        });
+        // Handle {@link module:ui/view~View#element} in DOM when a view is removed from the collection.
+        this.on('remove', (evt, view) => {
+            if (view.element && this._parentElement) {
+                view.element.remove();
+            }
+        });
+        this._parentElement = null;
+    }
+    /**
+     * Destroys the view collection along with child views.
+     * See the view {@link module:ui/view~View#destroy} method.
+     */
+    destroy() {
+        this.map(view => view.destroy());
+    }
+    /**
+     * Sets the parent HTML element of this collection. When parent is set, {@link #add adding} and
+     * {@link #remove removing} views in the collection synchronizes their
+     * {@link module:ui/view~View#element elements} in the parent element.
+     *
+     * @param element A new parent element.
+     */
+    setParent(elementOrDocFragment) {
+        this._parentElement = elementOrDocFragment;
+        // Take care of the initial collection items passed to the constructor.
+        for (const view of this) {
+            this._renderViewIntoCollectionParent(view);
+        }
+    }
+    /**
+     * Delegates selected events coming from within views in the collection to any
+     * {@link module:utils/emittermixin~Emitter}.
+     *
+     * For the following views and collection:
+     *
+     * ```ts
+     * const viewA = new View();
+     * const viewB = new View();
+     * const viewC = new View();
+     *
+     * const views = parentView.createCollection();
+     *
+     * views.delegate( 'eventX' ).to( viewB );
+     * views.delegate( 'eventX', 'eventY' ).to( viewC );
+     *
+     * views.add( viewA );
+     * ```
+     *
+     * the `eventX` is delegated (fired by) `viewB` and `viewC` along with `customData`:
+     *
+     * ```ts
+     * viewA.fire( 'eventX', customData );
+     * ```
+     *
+     * and `eventY` is delegated (fired by) `viewC` along with `customData`:
+     *
+     * ```ts
+     * viewA.fire( 'eventY', customData );
+     * ```
+     *
+     * See {@link module:utils/emittermixin~Emitter#delegate}.
+     *
+     * @param events {@link module:ui/view~View} event names to be delegated to another
+     * {@link module:utils/emittermixin~Emitter}.
+     * @returns Object with `to` property, a function which accepts the destination
+     * of {@link module:utils/emittermixin~Emitter#delegate delegated} events.
+     */
+    delegate(...events) {
+        if (!events.length || !isStringArray(events)) {
+            /**
+             * All event names must be strings.
+             *
+             * @error ui-viewcollection-delegate-wrong-events
+             */
+            throw new CKEditorError('ui-viewcollection-delegate-wrong-events', this);
+        }
+        return {
+            to: dest => {
+                // Activate delegating on existing views in this collection.
+                for (const view of this) {
+                    for (const evtName of events) {
+                        view.delegate(evtName).to(dest);
+                    }
+                }
+                // Activate delegating on future views in this collection.
+                this.on('add', (evt, view) => {
+                    for (const evtName of events) {
+                        view.delegate(evtName).to(dest);
+                    }
+                });
+                // Deactivate delegating when view is removed from this collection.
+                this.on('remove', (evt, view) => {
+                    for (const evtName of events) {
+                        view.stopDelegating(evtName, dest);
+                    }
+                });
+            }
+        };
+    }
+    /**
+     * This method {@link module:ui/view~View#render renders} a new view added to the collection.
+     *
+     * If the {@link #_parentElement parent element} of the collection is set, this method also adds
+     * the view's {@link module:ui/view~View#element} as a child of the parent in DOM at a specified index.
+     *
+     * **Note**: If index is not specified, the view's element is pushed as the last child
+     * of the parent element.
+     *
+     * @param view A new view added to the collection.
+     * @param index An index the view holds in the collection. When not specified,
+     * the view is added at the end.
+     */
+    _renderViewIntoCollectionParent(view, index) {
+        if (!view.isRendered) {
+            view.render();
+        }
+        if (view.element && this._parentElement) {
+            this._parentElement.insertBefore(view.element, this._parentElement.children[index]);
+        }
+    }
+    /**
+     * Removes a child view from the collection. If the {@link #setParent parent element} of the
+     * collection has been set, the {@link module:ui/view~View#element element} of the view is also removed
+     * in DOM, reflecting the order of the collection.
+     *
+     * See the {@link #add} method.
+     *
+     * @param subject The view to remove, its id or index in the collection.
+     * @returns The removed view.
+     */
+    remove(subject) {
+        return super.remove(subject);
+    }
+}
+/**
+ * Check if all entries of the array are of `String` type.
+ *
+ * @param arr An array to be checked.
+ */
+function isStringArray(arr) {
+    return arr.every(a => typeof a == 'string');
+}

package/theme/components/autocomplete/autocomplete.css

@@ -0,0 +1,22 @@
+/*
+ * 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
+ */
+
+.ck.ck-autocomplete {
+	position: relative;
+
+	& > .ck-search__results {
+		position: absolute;
+		z-index: var(--ck-z-modal);
+
+		&.ck-search__results_n {
+			bottom: 100%;
+		}
+
+		&.ck-search__results_s {
+			top: 100%;
+			bottom: auto;
+		}
+	}
+}

package/theme/components/formheader/formheader.css

@@ -9,4 +9,12 @@
 	flex-wrap: nowrap;
 	align-items: center;
 	justify-content: space-between;
+
+	& .ck-icon {
+		margin-right: var(--ck-spacing-medium);
+	}
+
+	& h2.ck-form__header__label {
+		flex-grow: 1;
+	}
 }

package/theme/components/highlightedtext/highlightedtext.css

@@ -0,0 +1,12 @@
+/*
+ * 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
+ */
+
+.ck.ck-highlighted-text mark {
+	background: var(--ck-color-highlight-background);
+	vertical-align: initial;
+	font-weight: inherit;
+	line-height: inherit;
+	font-size: inherit;
+}

package/theme/components/search/search.css

@@ -0,0 +1,43 @@
+/*
+ * 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 "@ckeditor/ckeditor5-ui/theme/mixins/_dir.css";
+
+.ck.ck-search {
+	& > .ck-labeled-field-view {
+		& > .ck-labeled-field-view__input-wrapper > .ck-icon {
+			position: absolute;
+			top: 50%;
+			transform: translateY(-50%);
+
+			@mixin ck-dir ltr {
+				left: var(--ck-spacing-medium);
+			}
+
+			@mixin ck-dir rtl {
+				right: var(--ck-spacing-medium);
+			}
+		}
+
+		& .ck-search__reset {
+			position: absolute;
+			top: 50%;
+			transform: translateY(-50%);
+		}
+	}
+
+	& > .ck-search__results {
+		& > .ck-search__info {
+			& > span:first-child {
+				display: block;
+			}
+
+			/* Hide the filtered view when nothing was found */
+			&:not(.ck-hidden) ~ * {
+				display: none;
+			}
+		}
+	}
+}

package/theme/components/spinner/spinner.css

@@ -0,0 +1,23 @@
+/*
+ * 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
+ */
+
+:root {
+	--ck-toolbar-spinner-size: 18px;
+}
+
+.ck.ck-spinner-container {
+	display: block;
+	position: relative;
+}
+
+.ck.ck-spinner {
+	position: absolute;
+	top: 50%;
+	left: 0;
+	right: 0;
+	margin: 0 auto;
+	transform: translateY(-50%);
+	z-index: 1;
+}

package/theme/components/textarea/textarea.css

@@ -0,0 +1,10 @@
+/*
+ * 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
+ */
+
+/*
+ * Note: This file should contain the wireframe styles only. But since there are no such styles,
+ * it acts as a message to the builder telling that it should look for the corresponding styles
+ * **in the theme** when compiling the editor.
+ */