@ckeditor/ckeditor5-editor-multi-root 0.0.0-nightly-20240522.0 → 0.0.0-nightly-20240524.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -2
- package/dist/index.js +1 -29
- package/dist/index.js.map +1 -1
- package/dist/types/multirooteditor.d.ts +1 -29
- package/package.json +2 -2
- package/src/multirooteditor.d.ts +1 -29
- package/src/multirooteditor.js +1 -29
package/README.md
CHANGED
@@ -5,16 +5,22 @@ CKEditor 5 multi-root editor implementation
|
|
5
5
|
[](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
|
6
6
|
[](https://app.travis-ci.com/github/ckeditor/ckeditor5)
|
7
7
|
|
8
|
-
The multi-root editor implementation for CKEditor 5. Read more about the [multi-root editor build](https://ckeditor.com/docs/ckeditor5/latest/
|
8
|
+
The multi-root editor implementation for CKEditor 5. Read more about the [multi-root editor build](https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/installation-methods/predefined-builds.html#multi-root-editor) and see the [demo](https://ckeditor.com/docs/ckeditor5/latest/examples/builds/multi-root-editor.html).
|
9
9
|
|
10
10
|
This package contains the [`MultiRootEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-multi-root_multirooteditor-MultiRootEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.
|
11
11
|
|
12
|
-
This package contains the source version of the multi-root editor. Read more about [CKEditor 5 predefined builds](https://ckeditor.com/docs/ckeditor5/latest/
|
12
|
+
This package contains the source version of the multi-root editor. Read more about [CKEditor 5 predefined builds](https://ckeditor.com/docs/ckeditor5/latest/getting-started/legacy/advanced/alternative-setups/predefined-builds.html) in the CKEditor 5 documentation.
|
13
13
|
|
14
14
|
## Documentation
|
15
15
|
|
16
16
|
See the [`@ckeditor/ckeditor5-editor-multi-root` package](https://ckeditor.com/docs/ckeditor5/latest/api/editor-multi-root.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
|
17
17
|
|
18
|
+
## Installation
|
19
|
+
|
20
|
+
```bash
|
21
|
+
npm install ckeditor5
|
22
|
+
```
|
23
|
+
|
18
24
|
## License
|
19
25
|
|
20
26
|
Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).
|
package/dist/index.js
CHANGED
@@ -283,7 +283,7 @@ import { isElement as isElement$1 } from 'lodash-es';
|
|
283
283
|
}
|
284
284
|
|
285
285
|
/**
|
286
|
-
* The
|
286
|
+
* The multi-root editor implementation.
|
287
287
|
*
|
288
288
|
* The multi-root editor provides multiple inline editable elements and a toolbar. All editable areas are controlled by one editor
|
289
289
|
* instance, which means that they share common configuration, document ID, or undo stack.
|
@@ -295,22 +295,6 @@ import { isElement as isElement$1 } from 'lodash-es';
|
|
295
295
|
* {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`} method.
|
296
296
|
*
|
297
297
|
* Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.
|
298
|
-
*
|
299
|
-
* # Multi-root editor and multi-root editor build
|
300
|
-
*
|
301
|
-
* The multi-root editor can be used directly from source (if you installed the
|
302
|
-
* [`@ckeditor/ckeditor5-editor-multi-root`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-multi-root) package)
|
303
|
-
* but it is also available in the
|
304
|
-
* {@glink installation/getting-started/predefined-builds#multi-root-editor multi-root editor build}.
|
305
|
-
*
|
306
|
-
* {@glink installation/getting-started/predefined-builds Builds} are ready-to-use editors with plugins bundled in.
|
307
|
-
*
|
308
|
-
* When using the editor from source you need to take care of loading all plugins by yourself
|
309
|
-
* (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
|
310
|
-
* Using the editor from source gives much better flexibility and allows for easier customization.
|
311
|
-
*
|
312
|
-
* Read more about initializing the editor from source or as a build in
|
313
|
-
* {@link module:editor-multi-root/multirooteditor~MultiRootEditor.create `MultiRootEditor.create()`}.
|
314
298
|
*/ class MultiRootEditor extends Editor {
|
315
299
|
/**
|
316
300
|
* @inheritDoc
|
@@ -1009,18 +993,6 @@ import { isElement as isElement$1 } from 'lodash-es';
|
|
1009
993
|
* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
|
1010
994
|
* customizing plugins, toolbar and more.
|
1011
995
|
*
|
1012
|
-
* # Using the editor from source
|
1013
|
-
*
|
1014
|
-
* The code samples listed in the previous sections of this documentation assume that you are using an
|
1015
|
-
* {@glink installation/getting-started/predefined-builds editor build}
|
1016
|
-
* (for example – `@ckeditor/ckeditor5-build-multi-root`).
|
1017
|
-
*
|
1018
|
-
* If you want to use the multi-root editor from source (`@ckeditor/ckeditor5-editor-multi-root-editor/src/multirooteditor`),
|
1019
|
-
* you need to define the list of
|
1020
|
-
* {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
|
1021
|
-
* {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
|
1022
|
-
* source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
|
1023
|
-
*
|
1024
996
|
* @param sourceElementsOrData The DOM elements that will be the source for the created editor
|
1025
997
|
* or the editor's initial data. The editor will initialize multiple roots with names according to the keys in the passed object.
|
1026
998
|
*
|