@ckeditor/ckeditor5-core 38.0.0 → 38.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-core",
-  "version": "38.0.0",
+  "version": "38.1.0",
   "description": "The core architecture of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -23,29 +23,10 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-engine": "^38.0.0",
-    "@ckeditor/ckeditor5-utils": "^38.0.0",
+    "@ckeditor/ckeditor5-engine": "38.1.0",
+    "@ckeditor/ckeditor5-utils": "38.1.0",
     "lodash-es": "^4.17.15"
   },
-  "devDependencies": {
-    "@ckeditor/ckeditor5-autoformat": "^38.0.0",
-    "@ckeditor/ckeditor5-basic-styles": "^38.0.0",
-    "@ckeditor/ckeditor5-block-quote": "^38.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^38.0.0",
-    "@ckeditor/ckeditor5-essentials": "^38.0.0",
-    "@ckeditor/ckeditor5-heading": "^38.0.0",
-    "@ckeditor/ckeditor5-image": "^38.0.0",
-    "@ckeditor/ckeditor5-indent": "^38.0.0",
-    "@ckeditor/ckeditor5-link": "^38.0.0",
-    "@ckeditor/ckeditor5-list": "^38.0.0",
-    "@ckeditor/ckeditor5-media-embed": "^38.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^38.0.0",
-    "@ckeditor/ckeditor5-table": "^38.0.0",
-    "@ckeditor/ckeditor5-ui": "^38.0.0",
-    "typescript": "^4.8.4",
-    "webpack": "^5.58.1",
-    "webpack-cli": "^4.9.0"
-  },
   "engines": {
     "node": ">=16.0.0",
     "npm": ">=5.7.1"
@@ -67,9 +48,5 @@
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
-  "scripts": {
-    "build": "tsc -p ./tsconfig.json",
-    "postversion": "npm run build"
-  },
   "types": "src/index.d.ts"
 }

package/src/editor/editorconfig.d.ts

@@ -446,12 +446,12 @@ export interface EditorConfig {
      * 	.catch( ... );
      * ```
      *
-     * Options which can be set using the UI config:
+     * Options which can be set using the UI configuration:
      *
-     * * **`ui.viewportOffset`** – The offset (in pixels) of the viewport from every direction used when positioning a sticky toolbar
-     * or other absolutely positioned UI elements.
+     * * **`ui.viewportOffset`** – The offset (in pixels) of the viewport from every direction. It is
+     * used when positioning a sticky toolbar or other absolutely positioned UI elements.
      * Useful when a page with which the editor is being integrated has some other sticky or fixed elements
-     * (e.g. the top menu). Thanks to setting the UI viewport offset the toolbar and other contextual balloons will not be positioned
+     * (e.g. the top menu). Thanks to setting the UI viewport offset, the toolbar and other contextual balloons will not be positioned
      * underneath or above the page's UI.
      *
      * 	```ts
@@ -460,28 +460,28 @@ export interface EditorConfig {
      * 	}
      * 	```
      *
-     * 	**Note:** If you want to modify the viewport offset in runtime (after editor was created), you can do that by overriding
+     * 	**Note:** If you want to modify the viewport offset in runtime (after the editor was created), you can do that by overriding
      * 	{@link module:ui/editorui/editorui~EditorUI#viewportOffset `editor.ui.viewportOffset`}.
      *
-     * * **`ui.poweredBy`** – The configuration of the project logo displayed over editor's editing are in open-source integrations.
-     * It allows customizing the position of the logo to minimize the risk of collision with editor content
-     * and UI.
+     * * **`ui.poweredBy`** – The configuration of the project logo displayed over the editor's editing area in
+     *  open-source integrations. It allows customizing the position of the logo to minimize the risk of collision with the
+     *  editor content and UI.
      *
      * 	The following configuration properties are supported:
      *
-     * 	* **`position`** – Position of the project's logo (default: `'border'`).
-     * 		* When `'inside'` the logo will be displayed within the boundaries of the editing area.
-     * 		* When `'border'` the logo will be displayed over the bottom border of the editing area.
+     * 	* **`position`** – The position of the project's logo (default: `'border'`).
+     * 		* When `'inside'`, the logo will be displayed within the boundaries of the editing area.
+     * 		* When `'border'`, the logo will be displayed over the bottom border of the editing area.
      *
-     * 	* **`side`** (`'left'` or `'right'`, default: `'right'`) – Allows choosing the side of the editing area the
-     * 	logo will be displayed to.
+     * 	* **`side`** (`'left'` or `'right'`, default: `'right'`) – The side of the editing area where the
+     * 	logo will be displayed.
      *
      * 		**Note**: If {@link module:core/editor/editorconfig~EditorConfig#language `config.language`} is set to an RTL (right-to-left)
      * 		language, the side switches to `'left'` by default.
      *
-     * 	* **`label`** (default: `'Powered by'`) – Allows changing the label displayed next to the project's logo.
+     * 	* **`label`** (default: `'Powered by'`) – The label displayed next to the project's logo.
      *
-     * 		**Note**: Set the value to `null` to display the logo without a text.
+     * 		**Note**: Set the value to `null` to display the logo without any text.
      *
      * 	* **`verticalOffset`** (default: `5`) – The vertical distance the logo can be moved away from its default position.
      *
@@ -502,18 +502,18 @@ export interface EditorConfig {
      */
     ui?: UiConfig;
     /**
-     * Enables updating the source element after the editor destroy.
+     * Enables updating the source element after the editor is destroyed.
      *
      * Enabling this option might have some security implications, as the editor doesn't have control over all data
      * in the output.
      *
-     * Be careful, especially while using
-     * {@glink features/markdown Markdown}, {@glink features/html/general-html-support General HTML Support} or
+     * Be careful, especially while using the
+     * {@glink features/markdown Markdown}, {@glink features/html/general-html-support General HTML Support}, or
      * {@glink features/html/html-embed HTML embed} features.
      */
     updateSourceElementOnDestroy?: boolean;
     /**
-     * The license key for the CKEditor 5 premium features.
+     * The license key for the CKEditor 5 commercial license and the premium features.
      *
      * If you do not have a key yet, please [contact us](https://ckeditor.com/contact/) or
      * [order a trial](https://orders.ckeditor.com/trial/premium-features).
@@ -521,7 +521,7 @@ export interface EditorConfig {
     licenseKey?: string;
 }
 /**
- * The `config.initialData` option cannot be used together with initial data passed as the first parameter of
+ * The `config.initialData` option cannot be used together with the initial data passed as the first parameter of
  * {@link module:core/editor/editor~Editor.create `Editor.create()`}.
  *
  * @error editor-create-initial-data
@@ -532,7 +532,7 @@ export interface EditorConfig {
  * ```ts
  * ClassicEditor
  * 	.create( document.querySelector( '#editor' ), {
- * 		language: ... // Editor language configuration.
+ * 		language: ... // The editor language configuration.
  * 	} )
  * 	.then( editor => {
  * 		console.log( editor );
@@ -546,13 +546,13 @@ export interface EditorConfig {
  */
 export interface LanguageConfig {
     /**
-     * Allows to use different language for the editor UI.
+     * Allows to use a different language for the editor UI.
      *
      * The language codes are defined in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) standard.
      */
     ui?: string;
     /**
-     * Allows to use different language of the editor content.
+     * Allows to use a different language of the editor content.
      *
      * The language codes are defined in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) standard.
      */
@@ -570,53 +570,91 @@ export type ToolbarConfigItem = string | {
     withText?: boolean;
     tooltip?: boolean | string | ((label: string, keystroke: string | undefined) => string);
 };
+/**
+ * The “Powered by CKEditor” logo configuration options.
+ **/
+export interface PoweredByConfig {
+    /**
+     * The position of the project's logo.
+     *
+     * * When `'inside'`, the logo will be displayed within the boundaries of the editing area.
+     * * When `'border'`, the logo will be displayed over the bottom border of the editing area.
+     *
+     * @default 'border'
+     */
+    position: 'inside' | 'border';
+    /**
+     * Allows choosing the side of the editing area where the logo will be displayed.
+     *
+     * **Note:** If {@link module:core/editor/editorconfig~EditorConfig#language `config.language`} is set to an RTL (right-to-left)
+     * language, the side switches to `'left'` by default.
+     *
+     * @default 'right'
+     */
+    side: 'left' | 'right';
+    /**
+     * Allows changing the label displayed next to the CKEditor logo.
+     *
+     * **Note:** Set the value to `null` to hide the label.
+     *
+     * @default 'Powered by'
+     */
+    label: string | null;
+    /**
+     * The vertical distance the logo can be moved away from its default position.
+     *
+     * **Note:** If `position` is `'border'`, the offset is measured from the (vertical) center of the logo.
+     *
+     * @default 5
+     */
+    verticalOffset: number;
+    /**
+     * The horizontal distance between the side of the editing root and the nearest side of the logo.
+     *
+     * @default 5
+     */
+    horizontalOffset: number;
+    /**
+     * Allows to show the logo even if the valid commercial license is configured using
+     * the {@link module:core/editor/editorconfig~EditorConfig#licenseKey `config.licenseKey`} setting.
+     *
+     * @default false
+     */
+    forceVisible?: boolean;
+}
+/**
+ * The offset (in pixels) of the viewport from every direction used when positioning a sticky toolbar or other
+ * absolutely positioned UI elements.
+ */
+export interface ViewportOffsetConfig {
+    /**
+     * The bottom offset in pixels.
+     */
+    bottom?: number;
+    /**
+     * The left offset in pixels.
+     */
+    left?: number;
+    /**
+     * The right offset in pixels.
+     */
+    right?: number;
+    /**
+     * The top offset in pixels.
+     */
+    top?: number;
+}
 export interface UiConfig {
-    viewportOffset?: {
-        bottom?: number;
-        left?: number;
-        right?: number;
-        top?: number;
-    };
-    poweredBy?: {
-        /**
-         * Position of the project's logo.
-         *
-         * * When `'inside'` the logo will be displayed within the boundaries of the editing area.
-         * * When `'border'` the logo will be displayed over the bottom border of the editing area.
-         *
-         * @default 'border'
-         */
-        position: 'inside' | 'border';
-        /**
-         * Allows choosing the side of the editing area the logo will be displayed to.
-         *
-         * **Note:** If {@link module:core/editor/editorconfig~EditorConfig#language `config.language`} is set to an RTL (right-to-left)
-         * language, the side switches to `'left'` by default.
-         *
-         * @default 'right'
-         */
-        side: 'left' | 'right';
-        /**
-         * Allows changing the label displayed next to the CKEditor logo.
-         *
-         * **Note:** Set the value to `null` to hide the label.
-         *
-         * @default 'Powered by'
-         */
-        label: string | null;
-        /**
-         * The vertical distance the logo can be moved away from its default position.
-         *
-         * **Note:** If `position` is `'border'`, the offset is measured from the (vertical) center of the logo.
-         *
-         * @default 5
-         */
-        verticalOffset: number;
-        /**
-         * The horizontal distance between the side of the editing root and the nearest side of the logo.
-         *
-         * @default 5
-         */
-        horizontalOffset: number;
-    };
+    /**
+     * The viewport offset used for positioning various absolutely positioned UI elements.
+     *
+     * Read more in {@link module:core/editor/editorconfig~ViewportOffsetConfig}.
+     **/
+    viewportOffset?: ViewportOffsetConfig;
+    /**
+     * The configuration of the “Powered by CKEditor” logo.
+     *
+     * Read more in {@link module:core/editor/editorconfig~PoweredByConfig}.
+     **/
+    poweredBy?: PoweredByConfig;
 }

package/src/index.d.ts

@@ -14,7 +14,7 @@ export { default as Context, type ContextConfig } from './context';
 export { default as ContextPlugin, type ContextPluginDependencies } from './contextplugin';
 export { type EditingKeystrokeCallback } from './editingkeystrokehandler';
 export { default as Editor, type EditorReadyEvent, type EditorDestroyEvent } from './editor/editor';
-export type { EditorConfig, LanguageConfig, ToolbarConfig, ToolbarConfigItem } from './editor/editorconfig';
+export type { EditorConfig, LanguageConfig, ToolbarConfig, ToolbarConfigItem, UiConfig } from './editor/editorconfig';
 export { default as attachToForm } from './editor/utils/attachtoform';
 export { default as DataApiMixin, type DataApi } from './editor/utils/dataapimixin';
 export { default as ElementApiMixin, type ElementApi } from './editor/utils/elementapimixin';

package/src/pendingactions.d.ts

@@ -66,7 +66,7 @@ export default class PendingActions extends ContextPlugin implements Iterable<Pe
     /**
      * @inheritDoc
      */
-    static get pluginName(): 'PendingActions';
+    static get pluginName(): "PendingActions";
     /**
      * @inheritDoc
      */

package/src/plugincollection.d.ts

@@ -96,8 +96,8 @@ export type PluginEntry<TContext> = [PluginConstructor<TContext>, PluginInterfac
  *
  * ```ts
  * class MyPlugin extends Plugin {
- * 	public static pluginName(): 'MyPlugin' {
- * 		return 'MyPlugin';
+ * 	public static pluginName() {
+ * 		return 'MyPlugin' as const;
  * 	}
  * }
  *

package/theme/icons/importexport.svg

@@ -1 +1 @@
-<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#a)"><path clip-rule="evenodd" d="M19 4.5 14 0H3v12.673l.868-1.041c.185-.222.4-.402.632-.54V1.5h8v5h5v7.626a2.24 2.24 0 0 1 1.5.822V4.5ZM14 5V2l3.3 3H14Zm-3.692 12.5c.062.105.133.206.213.303L11.52 19H8v-.876a2.243 2.243 0 0 0 1.82-.624h.488Zm7.518-.657a.75.75 0 0 0-1.152-.96L15.5 17.29V12H14v5.29l-1.174-1.408a.75.75 0 0 0-1.152.96l2.346 2.816a.95.95 0 0 0 1.46 0l2.346-2.815Zm-15.056-.38a.75.75 0 0 1-.096-1.056l2.346-2.815a.95.95 0 0 1 1.46 0l2.346 2.815a.75.75 0 1 1-1.152.96L6.5 14.96V20H5v-5.04l-1.174 1.408a.75.75 0 0 1-1.056.096Z"/></g><defs><clipPath id="a"><path d="M0 0h20v20H0z"/></clipPath></defs></svg>
+<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path d="M19 4.5 14 0H3v12.673l.868-1.041c.185-.222.4-.402.632-.54V1.5h8v5h5v7.626a2.24 2.24 0 0 1 1.5.822V4.5ZM14 5V2l3.3 3H14Zm-3.692 12.5c.062.105.133.206.213.303L11.52 19H8v-.876a2.243 2.243 0 0 0 1.82-.624h.488Zm7.518-.657a.75.75 0 0 0-1.152-.96L15.5 17.29V12H14v5.29l-1.174-1.408a.75.75 0 0 0-1.152.96l2.346 2.816a.95.95 0 0 0 1.46 0l2.346-2.815Zm-15.056-.38a.75.75 0 0 1-.096-1.056l2.346-2.815a.95.95 0 0 1 1.46 0l2.346 2.815a.75.75 0 1 1-1.152.96L6.5 14.96V20H5v-5.04l-1.174 1.408a.75.75 0 0 1-1.056.096Z"/></svg>

package/theme/icons/text.svg

@@ -1 +1 @@
-<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#a)"><path d="M9.816 11.5 7.038 4.785 4.261 11.5h5.555Zm.62 1.5H3.641l-1.666 4.028H.312l5.789-14h1.875l5.789 14h-1.663L10.436 13Z"/><path clip-rule="evenodd" d="m12.09 17-.534-1.292.848-1.971.545 1.319L12.113 17h-.023Zm1.142-5.187.545 1.319L15.5 9.13l1.858 4.316h-3.45l.398.965h3.467L18.887 17H20l-3.873-9h-1.254l-1.641 3.813Z"/></g><defs><clipPath id="a"><path d="M0 0h20v20H0z"/></clipPath></defs></svg>
+<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path d="M9.816 11.5 7.038 4.785 4.261 11.5h5.555Zm.62 1.5H3.641l-1.666 4.028H.312l5.789-14h1.875l5.789 14h-1.663L10.436 13Z"/><path d="m12.09 17-.534-1.292.848-1.971.545 1.319L12.113 17h-.023Zm1.142-5.187.545 1.319L15.5 9.13l1.858 4.316h-3.45l.398.965h3.467L18.887 17H20l-3.873-9h-1.254l-1.641 3.813Z"/></svg>