@ckeditor/ckeditor5-editor-classic 0.0.0-nightly-20240602.0 → 0.0.0-nightly-20240604.0

package/src/classiceditor.js

@@ -7,17 +7,34 @@
  */
 import ClassicEditorUI from './classiceditorui.js';
 import ClassicEditorUIView from './classiceditoruiview.js';
-import { Editor, ElementApiMixin, attachToForm } from 'ckeditor5/src/core.js';
+import { Editor, Context, ElementApiMixin, attachToForm } from 'ckeditor5/src/core.js';
 import { getDataFromElement, CKEditorError } from 'ckeditor5/src/utils.js';
+import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
 import { isElement as _isElement } from 'lodash-es';
 /**
- * The classic editor implementation. It uses an inline editable and a sticky toolbar, all enclosed in a boxed UI.
+ * The {@glink installation/getting-started/predefined-builds#classic-editor classic editor} implementation.
+ * It uses an inline editable and a sticky toolbar, all enclosed in a boxed UI.
  * See the {@glink examples/builds/classic-editor demo}.
  *
  * In order to create a classic editor instance, use the static
  * {@link module:editor-classic/classiceditor~ClassicEditor.create `ClassicEditor.create()`} method.
+ *
+ * # Classic editor and classic build
+ *
+ * The classic editor can be used directly from source (if you installed the
+ * [`@ckeditor/ckeditor5-editor-classic`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-classic) package)
+ * but it is also available in the {@glink installation/getting-started/predefined-builds#classic-editor classic 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 easier customization.
+ *
+ * Read more about initializing the editor from source or as a build in
+ * {@link module:editor-classic/classiceditor~ClassicEditor.create `ClassicEditor.create()`}.
  */
-export default class ClassicEditor extends /* #__PURE__ */ ElementApiMixin(Editor) {
+class ClassicEditor extends ElementApiMixin(Editor) {
     /**
      * Creates an instance of the classic editor.
      *
@@ -139,6 +156,17 @@ export default class ClassicEditor extends /* #__PURE__ */ ElementApiMixin(Edito
      * 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-classic`).
+     *
+     * If you want to use the classic editor from source (`@ckeditor/ckeditor5-editor-classic/src/classiceditor`),
+     * 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 sourceElementOrData The DOM element that will be the source for the created editor
      * or the editor's initial data.
      *
@@ -168,6 +196,25 @@ export default class ClassicEditor extends /* #__PURE__ */ ElementApiMixin(Edito
         });
     }
 }
+/**
+ * The {@link module:core/context~Context} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+ClassicEditor.Context = Context;
+/**
+ * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+ClassicEditor.EditorWatchdog = EditorWatchdog;
+/**
+ * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
+ *
+ * Exposed as static editor field for easier access in editor builds.
+ */
+ClassicEditor.ContextWatchdog = ContextWatchdog;
+export default ClassicEditor;
 function getInitialData(sourceElementOrData) {
     return isElement(sourceElementOrData) ? getDataFromElement(sourceElementOrData) : sourceElementOrData;
 }