@ckeditor/ckeditor5-editor-multi-root 0.0.0-nightly-20240602.0 → 0.0.0-nightly-20240604.0

package/dist/types/multirooteditor.d.ts

@@ -9,12 +9,13 @@
 /**
  * @module editor-multi-root/multirooteditor
  */
-import { Editor, type EditorConfig } from 'ckeditor5/src/core.js';
+import { Editor, Context, type EditorConfig } from 'ckeditor5/src/core.js';
 import { type DecoratedMethodEvent } from 'ckeditor5/src/utils.js';
+import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
 import MultiRootEditorUI from './multirooteditorui.js';
 import { type RootElement } from 'ckeditor5/src/engine.js';
 /**
- * The multi-root editor implementation.
+ * The {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor} implementation.
  *
  * The multi-root editor provides multiple inline editable elements and a toolbar. All editable areas are controlled by one editor
  * instance, which means that they share common configuration, document ID, or undo stack.
@@ -26,6 +27,22 @@ import { type RootElement } from 'ckeditor5/src/engine.js';
  * {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`} method.
  *
  * Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.
+ *
+ * # Multi-root editor and multi-root editor build
+ *
+ * The multi-root editor can be used directly from source (if you installed the
+ * [`@ckeditor/ckeditor5-editor-multi-root`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-multi-root) package)
+ * but it is also available in the
+ * {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor build}.
+ *
+ * {@glink installation/getting-started/predefined-builds Builds} are ready-to-use editors with plugins bundled in.
+ *
+ * When using the editor from source you need to take care of loading all plugins by yourself
+ * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
+ * Using the editor from source gives much better flexibility and allows for easier customization.
+ *
+ * Read more about initializing the editor from source or as a build in
+ * {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`}.
  */
 export default class MultiRootEditor extends Editor {
     /**
@@ -449,6 +466,18 @@ export default class MultiRootEditor extends Editor {
      * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
      * customizing plugins, toolbar and more.
      *
+     * # Using the editor from source
+     *
+     * The code samples listed in the previous sections of this documentation assume that you are using an
+     * {@glink installation/getting-started/predefined-builds editor build}
+     * (for example – `@ckeditor/ckeditor5-build-multi-root`).
+     *
+     * If you want to use the multi-root editor from source (`@ckeditor/ckeditor5-editor-multi-root-editor/src/multirooteditor`),
+     * you need to define the list of
+     * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
+     * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
+     * source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
+     *
      * @param sourceElementsOrData The DOM elements that will be the source for the created editor
      * or the editor's initial data. The editor will initialize multiple roots with names according to the keys in the passed object.
      *
@@ -465,6 +494,24 @@ export default class MultiRootEditor extends Editor {
      * @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
      */
     static create(sourceElementsOrData: Record<string, HTMLElement> | Record<string, string>, config?: EditorConfig): Promise<MultiRootEditor>;
+    /**
+     * The {@link module:core/context~Context} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static Context: typeof Context;
+    /**
+     * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static EditorWatchdog: typeof EditorWatchdog;
+    /**
+     * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static ContextWatchdog: typeof ContextWatchdog;
     /**
      * @internal
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-editor-multi-root",
-  "version": "0.0.0-nightly-20240602.0",
+  "version": "0.0.0-nightly-20240604.0",
   "description": "Multi-root editor implementation for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "0.0.0-nightly-20240602.0",
+    "ckeditor5": "0.0.0-nightly-20240604.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/multirooteditor.d.ts

@@ -5,12 +5,13 @@
 /**
  * @module editor-multi-root/multirooteditor
  */
-import { Editor, type EditorConfig } from 'ckeditor5/src/core.js';
+import { Editor, Context, type EditorConfig } from 'ckeditor5/src/core.js';
 import { type DecoratedMethodEvent } from 'ckeditor5/src/utils.js';
+import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
 import MultiRootEditorUI from './multirooteditorui.js';
 import { type RootElement } from 'ckeditor5/src/engine.js';
 /**
- * The multi-root editor implementation.
+ * The {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor} implementation.
  *
  * The multi-root editor provides multiple inline editable elements and a toolbar. All editable areas are controlled by one editor
  * instance, which means that they share common configuration, document ID, or undo stack.
@@ -22,6 +23,22 @@ import { type RootElement } from 'ckeditor5/src/engine.js';
  * {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`} method.
  *
  * Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.
+ *
+ * # Multi-root editor and multi-root editor build
+ *
+ * The multi-root editor can be used directly from source (if you installed the
+ * [`@ckeditor/ckeditor5-editor-multi-root`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-multi-root) package)
+ * but it is also available in the
+ * {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor build}.
+ *
+ * {@glink installation/getting-started/predefined-builds Builds} are ready-to-use editors with plugins bundled in.
+ *
+ * When using the editor from source you need to take care of loading all plugins by yourself
+ * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
+ * Using the editor from source gives much better flexibility and allows for easier customization.
+ *
+ * Read more about initializing the editor from source or as a build in
+ * {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`}.
  */
 export default class MultiRootEditor extends Editor {
     /**
@@ -445,6 +462,18 @@ export default class MultiRootEditor extends Editor {
      * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
      * customizing plugins, toolbar and more.
      *
+     * # Using the editor from source
+     *
+     * The code samples listed in the previous sections of this documentation assume that you are using an
+     * {@glink installation/getting-started/predefined-builds editor build}
+     * (for example – `@ckeditor/ckeditor5-build-multi-root`).
+     *
+     * If you want to use the multi-root editor from source (`@ckeditor/ckeditor5-editor-multi-root-editor/src/multirooteditor`),
+     * you need to define the list of
+     * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
+     * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
+     * source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
+     *
      * @param sourceElementsOrData The DOM elements that will be the source for the created editor
      * or the editor's initial data. The editor will initialize multiple roots with names according to the keys in the passed object.
      *
@@ -461,6 +490,24 @@ export default class MultiRootEditor extends Editor {
      * @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
      */
     static create(sourceElementsOrData: Record<string, HTMLElement> | Record<string, string>, config?: EditorConfig): Promise<MultiRootEditor>;
+    /**
+     * The {@link module:core/context~Context} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static Context: typeof Context;
+    /**
+     * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static EditorWatchdog: typeof EditorWatchdog;
+    /**
+     * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
+     *
+     * Exposed as static editor field for easier access in editor builds.
+     */
+    static ContextWatchdog: typeof ContextWatchdog;
     /**
      * @internal
      */

package/src/multirooteditor.js

@@ -5,13 +5,14 @@
 /**
  * @module editor-multi-root/multirooteditor
  */
-import { Editor, secureSourceElement } from 'ckeditor5/src/core.js';
+import { Editor, Context, secureSourceElement } from 'ckeditor5/src/core.js';
 import { CKEditorError, getDataFromElement, setDataInElement, logWarning } from 'ckeditor5/src/utils.js';
+import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
 import MultiRootEditorUI from './multirooteditorui.js';
 import MultiRootEditorUIView from './multirooteditoruiview.js';
 import { isElement as _isElement } from 'lodash-es';
 /**
- * The multi-root editor implementation.
+ * The {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor} implementation.
  *
  * The multi-root editor provides multiple inline editable elements and a toolbar. All editable areas are controlled by one editor
  * instance, which means that they share common configuration, document ID, or undo stack.
@@ -23,8 +24,24 @@ import { isElement as _isElement } from 'lodash-es';
  * {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`} method.
  *
  * Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.
+ *
+ * # Multi-root editor and multi-root editor build
+ *
+ * The multi-root editor can be used directly from source (if you installed the
+ * [`@ckeditor/ckeditor5-editor-multi-root`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-multi-root) package)
+ * but it is also available in the
+ * {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor build}.
+ *
+ * {@glink installation/getting-started/predefined-builds Builds} are ready-to-use editors with plugins bundled in.
+ *
+ * When using the editor from source you need to take care of loading all plugins by yourself
+ * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
+ * Using the editor from source gives much better flexibility and allows for easier customization.
+ *
+ * Read more about initializing the editor from source or as a build in
+ * {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`}.
  */
-export default class MultiRootEditor extends Editor {
+class MultiRootEditor extends Editor {
     /**
      * Creates an instance of the multi-root editor.
      *
@@ -718,6 +735,18 @@ export default class MultiRootEditor extends Editor {
      * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
      * customizing plugins, toolbar and more.
      *
+     * # Using the editor from source
+     *
+     * The code samples listed in the previous sections of this documentation assume that you are using an
+     * {@glink installation/getting-started/predefined-builds editor build}
+     * (for example – `@ckeditor/ckeditor5-build-multi-root`).
+     *
+     * If you want to use the multi-root editor from source (`@ckeditor/ckeditor5-editor-multi-root-editor/src/multirooteditor`),
+     * you need to define the list of
+     * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
+     * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
+     * source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
+     *
      * @param sourceElementsOrData The DOM elements that will be the source for the created editor
      * or the editor's initial data. The editor will initialize multiple roots with names according to the keys in the passed object.
      *
@@ -790,6 +819,25 @@ export default class MultiRootEditor extends Editor {
         }
     }
 }
+/**
+ * The {@link module:core/context~Context} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+MultiRootEditor.Context = Context;
+/**
+ * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+MultiRootEditor.EditorWatchdog = EditorWatchdog;
+/**
+ * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+MultiRootEditor.ContextWatchdog = ContextWatchdog;
+export default MultiRootEditor;
 function getInitialData(sourceElementOrData) {
     return isElement(sourceElementOrData) ? getDataFromElement(sourceElementOrData) : sourceElementOrData;
 }