ckeditor5 37.0.0-rc.0 → 37.0.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/CHANGELOG.md +223 -2
- package/README.md +44 -36
- package/build/ckeditor5-dll.js +1 -1
- package/package.json +14 -14
package/CHANGELOG.md
CHANGED
@@ -1,11 +1,231 @@
|
|
1
1
|
Changelog
|
2
2
|
=========
|
3
3
|
|
4
|
-
## [37.0.0
|
4
|
+
## [37.0.0](https://github.com/ckeditor/ckeditor5/compare/v36.0.1...v37.0.0) (2023-04-05)
|
5
5
|
|
6
6
|
### Release highlights
|
7
7
|
|
8
|
-
|
8
|
+
We are excited to announce that CKEditor 5 has been completely migrated to TypeScript, making v37.0.0 the first major release with full TypeScript support. This migration has brought numerous improvements, including better code organization and enhanced stability:
|
9
|
+
|
10
|
+
* **Full TypeScript support**: CKEditor now supports TypeScript in all its packages, making it easier for developers to write type-safe code and provide better code completion and error checking in IDEs.
|
11
|
+
* **Improved code quality**: The migration to TypeScript has allowed us to improve the overall code quality of CKEditor, resulting in better stability and performance.
|
12
|
+
* **Better documentation**: With TypeScript, we have been able to provide comprehensive and accurate type definitions for all the components in CKEditor, making it easier for developers to understand and use the API.
|
13
|
+
* **Enhanced developer experience**: TypeScript provides better tooling support, including code completion and error checking, which improves the overall developer experience.
|
14
|
+
|
15
|
+
Feel free to check our documentation to find out more about the [Using CKEditor 5 with a TypeScript setup](https://ckeditor.com/docs/ckeditor5/latest/installation/working-with-typescript.html) and read [the migration guide](https://ckeditor.com/docs/ckeditor5/latest/updating/guides/update-to-37.html).
|
16
|
+
|
17
|
+
We believe this release will be a significant milestone for CKEditor 5 and will provide a better development experience for our users. Please try it out and let us know your feedback by leaving a comment in this [issue](https://github.com/ckeditor/ckeditor5/issues/12027).
|
18
|
+
|
19
|
+
#### Comments archive
|
20
|
+
|
21
|
+
We are excited to introduce the Comments Archive feature. It provides a way to archive comments that are no longer relevant, reducing clutter and making it easier to focus on the most important feedback. Users can access the archive from the toolbar and use the comments archive dropdown to view and restore archived comments if necessary. This new feature will help simplify the feedback management process for our users.
|
22
|
+
|
23
|
+
#### Multi-root editor
|
24
|
+
|
25
|
+
In this release, we added official support for [multi-root editor type](https://ckeditor.com/docs/ckeditor5/latest/examples/builds/multi-root-editor.html) and a new [multi-root editor build](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#multi-root-editor). Additionally, we bring some fundamental improvements that make the multi-root editor more flexible and useful!
|
26
|
+
|
27
|
+
* Add and detach document roots. The multi-root editor will allow you to add or remove editing fields in your application in a dynamic fashion (i.e. after the editor was initialised), without the need to create additional editor instances.
|
28
|
+
* The multi-root editor will allow you to use root attributes to store additional metadata related to roots (editable fields). You can change these attributes and obtain them when you save the document data. Finally, you can react to these changes to alter how your application looks or behaves. Root attributes are a tool that will help you customize the editing experience further according to your needs. To take advantage of root attributes, you will need to provide a custom feature. As of now, there are no official plugins that would require saving and using the attributes of the root.
|
29
|
+
|
30
|
+
**The multi-root editor is still a project in progress!**
|
31
|
+
|
32
|
+
While the new predefined build is readily available, several features are not yet supported in the multi-root editor as of this release. These include: revision history, pagination, PDF/Word export, table resize, word count, HTML comments, full-page editing, title, mini-map, and the Cloud Services editor bundle. We will work on bringing support for these features in upcoming releases.
|
33
|
+
|
34
|
+
Other than that we look forward to sharing with you guides that will better explain how you can use these new improvements!
|
35
|
+
|
36
|
+
#### Tables
|
37
|
+
|
38
|
+
We expanded the General HTM Support feature with support for the `<colgroup>`’s and `<col>`’s attributes. We significantly refactored how these HTML elements are handled by the editor. They are now legit elements in the model instead of being kept as a `<table>` attribute.
|
39
|
+
|
40
|
+
### MAJOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
|
41
|
+
|
42
|
+
* Upgraded the minimal versions of Node.js to `16.0.0` due to the end of LTS.
|
43
|
+
|
44
|
+
### MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
|
45
|
+
|
46
|
+
* **[table](https://www.npmjs.com/package/@ckeditor/ckeditor5-table)**: The table columns' widths are stored as model elements instead of a model element attribute. See [#11479](https://github.com/ckeditor/ckeditor5/issues/11479).
|
47
|
+
* The [`@ckeditor/ckeditor5-watchdog`](https://www.npmjs.com/package/@ckeditor/ckeditor5-watchdog) package is no longer available as a standalone DLL build. It is now included in the main `ckeditor5-dll.js` build. See [#13707](https://github.com/ckeditor/ckeditor5/issues/13707).
|
48
|
+
|
49
|
+
### Features
|
50
|
+
|
51
|
+
* **[build-multi-root](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-multi-root)**: Introduced a new editor build featuring the multi-root editor. ([commit](https://github.com/ckeditor/ckeditor5/commit/50b9c4fe3dd8e22668f36c06af6cdc7af73d81cf))
|
52
|
+
* **[comments](https://www.npmjs.com/package/@ckeditor/ckeditor5-comments)**: Introduced comments archive. It is now possible to resolve a comment thread instead of removing it. Resolved comment threads can be reviewed in the comments archive and can be re-opened if the commented content is still available in the editor.
|
53
|
+
* **[comments](https://www.npmjs.com/package/@ckeditor/ckeditor5-comments)**: Introduced `comment:modify_all` permission that will allow the user to edit or remove all comments.
|
54
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: Introduced `model.Writer#addRoot()` and `model.Writer#detachRoot()`. Model roots can now be dynamically added to or detached from the document. All content gets removed from a detached root and new content cannot be inserted as long as the root is detached. Closes [#13388](https://github.com/ckeditor/ckeditor5/issues/13388). ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
55
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: Introduced `Differ.getChangedRoots()` which returns the roots added or detached since last the differ reset. `Differ#isEmpty` and `Differ#hasDataChanges()` will return `true` if a root was added or detached. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
56
|
+
* **[mention](https://www.npmjs.com/package/@ckeditor/ckeditor5-mention)**: Limiting the dropdown on the singular feed level should now be possible. Closes [#13504](https://github.com/ckeditor/ckeditor5/issues/13504). ([commit](https://github.com/ckeditor/ckeditor5/commit/489b3fda402504cb0492fceb368af475c8dd85b6))
|
57
|
+
* **[multi-root-editor](https://www.npmjs.com/package/@ckeditor/ckeditor5-multi-root-editor)**: Introduced the multi-root editor type that allows defining multiple editable areas handled by a single editor instance. Closes [#11493](https://github.com/ckeditor/ckeditor5/issues/11493). ([commit](https://github.com/ckeditor/ckeditor5/commit/50b9c4fe3dd8e22668f36c06af6cdc7af73d81cf))
|
58
|
+
* **[real-time-collaboration](https://www.npmjs.com/package/@ckeditor/ckeditor5-real-time-collaboration)**: Added support for custom path prefixes in WebSocket URLs. Any path proceeding the required `/ws` part in the WebSocket URL is now preserved.
|
59
|
+
|
60
|
+
### Bug fixes
|
61
|
+
|
62
|
+
* **[build-*](https://www.npmjs.com/search?q=keywords%3Ackeditor5-build%20maintainer%3Ackeditor)**: Typings from the CKEditor 5 builds contain types of loaded plugins. Closes [#13676](https://github.com/ckeditor/ckeditor5/issues/13676). ([commit](https://github.com/ckeditor/ckeditor5/commit/fea9b5a22259cb72525ef61a3c117c55ebdd62e4))
|
63
|
+
* **[clipboard](https://www.npmjs.com/package/@ckeditor/ckeditor5-clipboard)**: Dragging images in the editor should not lag in Firefox. Closes [#13366](https://github.com/ckeditor/ckeditor5/issues/13366). ([commit](https://github.com/ckeditor/ckeditor5/commit/04c7d47f6a35b3a866ce624a6b8e42510b5eefbd))
|
64
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: Dragging images in the editor should not lag in Firefox. Closes [#13366](https://github.com/ckeditor/ckeditor5/issues/13366). ([commit](https://github.com/ckeditor/ckeditor5/commit/04c7d47f6a35b3a866ce624a6b8e42510b5eefbd))
|
65
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: The `Renderer` should try to update existing DOM text nodes (instead of replacing them completely) so that external tools should not get lost if the watched DOM text node is removed and replaced with another one. Closes [#13051](https://github.com/ckeditor/ckeditor5/issues/13051). ([commit](https://github.com/ckeditor/ckeditor5/commit/617497a8ebe03a9f66f327479dff92c3dd10fe1c))
|
66
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: The `elementToStructure()` downcast helper should not skip attribute changes that happened with the modification of the children list. ([commit](https://github.com/ckeditor/ckeditor5/commit/61debdca19f7a5166433220b819232d20d8b9f26))
|
67
|
+
* **[html-support](https://www.npmjs.com/package/@ckeditor/ckeditor5-html-support)**: Attributes on the `<colgroup>`, and `<col>` elements should be preserved in the data. Closes [#11479](https://github.com/ckeditor/ckeditor5/issues/11479). ([commit](https://github.com/ckeditor/ckeditor5/commit/61debdca19f7a5166433220b819232d20d8b9f26))
|
68
|
+
* **[html-support](https://www.npmjs.com/package/@ckeditor/ckeditor5-html-support)**: Fixed description lists with name-value groups wrapped in div elements when upcasting using the General HTML Support feature. Closes [#12240](https://github.com/ckeditor/ckeditor5/issues/12240). ([commit](https://github.com/ckeditor/ckeditor5/commit/cb96419897e114e40dbeeca902b7463af372866f))
|
69
|
+
* **[image](https://www.npmjs.com/package/@ckeditor/ckeditor5-image)**: Fixed the image resize handle displaying `NaN` in some scenarios. Closes [#10776](https://github.com/ckeditor/ckeditor5/issues/10776). ([commit](https://github.com/ckeditor/ckeditor5/commit/5d280fa041b43331c09a0db0f393f15c7b848f96))
|
70
|
+
* **[link](https://www.npmjs.com/package/@ckeditor/ckeditor5-link)**: The link text should update along with the URL if they were the same in the first place. Closes [#12588](https://github.com/ckeditor/ckeditor5/issues/12588). ([commit](https://github.com/ckeditor/ckeditor5/commit/0beb8c638e10d69160219629b44e8bee00d6c744))
|
71
|
+
* **[mention](https://www.npmjs.com/package/@ckeditor/ckeditor5-mention)**: Mentions reexport the `MentionFeed` and `ItemRenderer` types. Closes [#13705](https://github.com/ckeditor/ckeditor5/issues/13705). ([commit](https://github.com/ckeditor/ckeditor5/commit/191f6cc9975f9055687fd963738b6eeba8727466))
|
72
|
+
* **[mention](https://www.npmjs.com/package/@ckeditor/ckeditor5-mention)**: Make a text property optional in the `MentionFeedObjectItem` type. Closes [#13550](https://github.com/ckeditor/ckeditor5/issues/13550). ([commit](https://github.com/ckeditor/ckeditor5/commit/7df46f84fba04280b3de3d98e4d666d4d046945c))
|
73
|
+
* **[mention](https://www.npmjs.com/package/@ckeditor/ckeditor5-mention)**: Mentions panel should be positioned left to the caret in editors with a right–to–left UI language. Closes [#13459](https://github.com/ckeditor/ckeditor5/issues/13459). ([commit](https://github.com/ckeditor/ckeditor5/commit/45ac9e29e87c02d5ce26fa461075c6f21c6d44a8))
|
74
|
+
* **[paste-from-office](https://www.npmjs.com/package/@ckeditor/ckeditor5-paste-from-office)**: Fixed handling of bold text in RTL lists pasted from MS Word. Closes [#13711](https://github.com/ckeditor/ckeditor5/issues/13711). ([commit](https://github.com/ckeditor/ckeditor5/commit/3abb8df5dfafbd31b432ada801e8878aff3b2eca))
|
75
|
+
* **[table](https://www.npmjs.com/package/@ckeditor/ckeditor5-table)**: Changed detection on heading rows and columns on table upcast. Closes [#3172](https://github.com/ckeditor/ckeditor5/issues/3172). ([commit](https://github.com/ckeditor/ckeditor5/commit/6f7e441d61fd1958f18740992e2bc8789cae302a))
|
76
|
+
* **[track-changes](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes)**: Suggestion annotation discard button state is now bound with the `DiscardSuggestionCommand` state, instead of `AcceptSuggestionCommand`.
|
77
|
+
* **[track-changes](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes)**: Fixed error thrown when a list item was created using autoformatting in the track changes mode.
|
78
|
+
* **[track-changes](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes)**: List style and document list style iss now applied directly to a non-list element when used in the track changes mode.
|
79
|
+
|
80
|
+
### Other changes
|
81
|
+
|
82
|
+
* **[core](https://www.npmjs.com/package/@ckeditor/ckeditor5-core)**: The `EditorConfig#initialData` and `EditorConfig#placeholder` options can now be set to `Record<string, string>` where the keys are root names and the values are settings for the related roots. ([commit](https://github.com/ckeditor/ckeditor5/commit/50b9c4fe3dd8e22668f36c06af6cdc7af73d81cf))
|
83
|
+
* **[editor-*](https://www.npmjs.com/search?q=keywords%3Ackeditor5-editor%20maintainer%3Ackeditor)**: Exposed the `Context`, `EditorWatchdog`, and `ContextWatchdog` classes as static editor properties. Closes [#13707](https://github.com/ckeditor/ckeditor5/issues/13707). ([commit](https://github.com/ckeditor/ckeditor5/commit/8933c865f9e54e9dae5e94f1b8743ee169ab3456))
|
84
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: `RootAttributeOperation` is now correctly handled by `Differ`. Root attribute changes will be returned in `Differ#getChangedRoots()`. ([commit](https://github.com/ckeditor/ckeditor5/commit/c121061db5bd02cdf3c088ea7a38ec0b4614b121))
|
85
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: `model.Document#getRootNames()` now returns only attached roots by default. The `includeDetached` parameter was introduced to enable returning detached roots as well. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
86
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: Introduced `RootOperation`. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
87
|
+
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: `model.DocumentFragment#isAttached` was introduced for compatibility reasons. It always returns `false`. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
88
|
+
* **[style](https://www.npmjs.com/package/@ckeditor/ckeditor5-style)**: Introduced the `StyleUtils` plugin to make the style util functions accessible. Closes [#13484](https://github.com/ckeditor/ckeditor5/issues/13484). ([commit](https://github.com/ckeditor/ckeditor5/commit/ee181f9903b09701deba2d3d85dab25fb5fadfbf))
|
89
|
+
* **[table](https://www.npmjs.com/package/@ckeditor/ckeditor5-table)**: The table columns' widths are stored as model elements instead of model element attributes. See [#11479](https://github.com/ckeditor/ckeditor5/issues/11479). ([commit](https://github.com/ckeditor/ckeditor5/commit/61debdca19f7a5166433220b819232d20d8b9f26))
|
90
|
+
* **[track-changes](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes)**: Introduced the `BaseSuggestionThreadView#canAccept` and `#canDiscard` observable properties. These properties are bound with related suggestions commands. `SuggestionThreadView#acceptButton.isEnabled` and `#discardButton.isEnabled` are bound to `#canAccept` an `#canDiscard`.
|
91
|
+
* **[ui](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui)**: Introduced `EditorUI#removeEditableElement()`. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
92
|
+
* **[utils](https://www.npmjs.com/package/@ckeditor/ckeditor5-utils)**: Added configuration to the `View#scrollToTheSelection()` helper allowing to scroll to the top of the boundary. Closes [#13688](https://github.com/ckeditor/ckeditor5/issues/13688). ([commit](https://github.com/ckeditor/ckeditor5/commit/75a5b122690c775cf55d61f3d80519cb85952ebb))
|
93
|
+
* Introduced `Observer#stopObserving()` to allow for proper removal of DOM editable elements from the editor. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
94
|
+
* Improved augmentation in some packages. Related to [#13565](https://github.com/ckeditor/ckeditor5/issues/13565). ([commit](https://github.com/ckeditor/ckeditor5/commit/3869a1bdadc0aa9c83990ddbf20710b3eebb7e2b))
|
95
|
+
* Updated the required version of Node.js to 16. See [#13671](https://github.com/ckeditor/ckeditor5/issues/13671). ([commit](https://github.com/ckeditor/ckeditor5/commit/b70d102dcb77067dbe744270221c707e681583fd))
|
96
|
+
* The remaining CKEditor 5 packages have been rewritten to TypeScript:
|
97
|
+
* **[@ckeditor/ckeditor5-autosave](https://www.npmjs.com/package/@ckeditor/ckeditor5-autosave)**: closes [#12997](https://github.com/ckeditor/ckeditor5/issues/12997). ([commit](https://github.com/ckeditor/ckeditor5/commit/7dea975058cfa1bd0c6b6b42a96187c3706547d9))
|
98
|
+
* **[@ckeditor/ckeditor5-build-balloon](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon)**: closes [#13000](https://github.com/ckeditor/ckeditor5/issues/13000). ([commit](https://github.com/ckeditor/ckeditor5/commit/4bf33ea3dc14b2354ec392bb34aa1bcce78b5ecc))
|
99
|
+
* **[@ckeditor/ckeditor5-build-balloon-block](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon-block)**: closes [#13001](https://github.com/ckeditor/ckeditor5/issues/13001). ([commit](https://github.com/ckeditor/ckeditor5/commit/4bf33ea3dc14b2354ec392bb34aa1bcce78b5ecc))
|
100
|
+
* **[@ckeditor/ckeditor5-build-classic](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic)**: closes [#13002](https://github.com/ckeditor/ckeditor5/issues/13002). ([commit](https://github.com/ckeditor/ckeditor5/commit/4bf33ea3dc14b2354ec392bb34aa1bcce78b5ecc))
|
101
|
+
* **[@ckeditor/ckeditor5-build-decoupled-document](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-decoupled-document)**: closes [#13003](https://github.com/ckeditor/ckeditor5/issues/13003). ([commit](https://github.com/ckeditor/ckeditor5/commit/4bf33ea3dc14b2354ec392bb34aa1bcce78b5ecc))
|
102
|
+
* **[@ckeditor/ckeditor5-build-inline](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-inline)**: closes [#13004](https://github.com/ckeditor/ckeditor5/issues/13004). ([commit](https://github.com/ckeditor/ckeditor5/commit/4bf33ea3dc14b2354ec392bb34aa1bcce78b5ecc))
|
103
|
+
* **[@ckeditor/ckeditor5-ckbox](https://www.npmjs.com/package/@ckeditor/ckeditor5-ckbox)**: closes [#13005](https://github.com/ckeditor/ckeditor5/issues/13005). ([commit](https://github.com/ckeditor/ckeditor5/commit/37dee8727bb44b2685a1e83285fd9d4fad0a04f7))
|
104
|
+
* **[@ckeditor/ckeditor5-ckfinder](https://www.npmjs.com/package/@ckeditor/ckeditor5-ckfinder)**: closes [#13006](https://github.com/ckeditor/ckeditor5/issues/13006). ([commit](https://github.com/ckeditor/ckeditor5/commit/fa105ac35c8666222967d5153b465d402d64d45a))
|
105
|
+
* **[@ckeditor/ckeditor5-cloud-services](https://www.npmjs.com/package/@ckeditor/ckeditor5-cloud-services)**: closes [#13007](https://github.com/ckeditor/ckeditor5/issues/13007). ([commit](https://github.com/ckeditor/ckeditor5/commit/37dee8727bb44b2685a1e83285fd9d4fad0a04f7))
|
106
|
+
* **[@ckeditor/ckeditor5-easy-image](https://www.npmjs.com/package/@ckeditor/ckeditor5-easy-image)**: closes [#13009](https://github.com/ckeditor/ckeditor5/issues/13009). ([commit](https://github.com/ckeditor/ckeditor5/commit/fc2381107156955346104ae59796b696711d9605))
|
107
|
+
* **[@ckeditor/ckeditor5-find-and-replace](https://www.npmjs.com/package/@ckeditor/ckeditor5-find-and-replace)**: closes [#13010](https://github.com/ckeditor/ckeditor5/issues/13010). ([commit](https://github.com/ckeditor/ckeditor5/commit/14fc8f2ed675ab531d3d9a27f7e2b6d8b2ade8a4))
|
108
|
+
* **[@ckeditor/ckeditor5-font](https://www.npmjs.com/package/@ckeditor/ckeditor5-font)**: closes [#13011](https://github.com/ckeditor/ckeditor5/issues/13011). ([commit](https://github.com/ckeditor/ckeditor5/commit/80ffea2dbe1911667a4246e253dd9d01626cfa49))
|
109
|
+
* **[@ckeditor/ckeditor5-html-embed](https://www.npmjs.com/package/@ckeditor/ckeditor5-html-embed)**: closes [#13015](https://github.com/ckeditor/ckeditor5/issues/13015). ([commit](https://github.com/ckeditor/ckeditor5/commit/9a90e4b137c1f850eec59c55ae2ff0faaa71efdc))
|
110
|
+
* **[@ckeditor/ckeditor5-html-support](https://www.npmjs.com/package/@ckeditor/ckeditor5-html-support)**: closes [#13016](https://github.com/ckeditor/ckeditor5/issues/13016). ([commit](https://github.com/ckeditor/ckeditor5/commit/7e601da88c9f6c9ac64316df3ddb7a9de28e3e2a))
|
111
|
+
* **[@ckeditor/ckeditor5-indent](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent)**: closes [#13018](https://github.com/ckeditor/ckeditor5/issues/13018). ([commit](https://github.com/ckeditor/ckeditor5/commit/9d57f22146022245b2873cf65759e76506cd3dc9))
|
112
|
+
* **[@ckeditor/ckeditor5-link](https://www.npmjs.com/package/@ckeditor/ckeditor5-link)**: closes [#13020](https://github.com/ckeditor/ckeditor5/issues/13020). ([commit](https://github.com/ckeditor/ckeditor5/commit/0c5cbc9af6226b3324464a269fa96909cf62586c))
|
113
|
+
* **[@ckeditor/ckeditor5-media-embed](https://www.npmjs.com/package/@ckeditor/ckeditor5-media-embed)**: closes [#13023](https://github.com/ckeditor/ckeditor5/issues/13023). ([commit](https://github.com/ckeditor/ckeditor5/commit/2a8f267f53315fdee1a4d2fd34b1c9819e986e3d))
|
114
|
+
* **[@ckeditor/ckeditor5-remove-format](https://www.npmjs.com/package/@ckeditor/ckeditor5-remove-format)**: closes [#13028](https://github.com/ckeditor/ckeditor5/issues/13028). ([commit](https://github.com/ckeditor/ckeditor5/commit/8e66507d160fc2857278f4bfd7c0ea9a4e9f10a8))
|
115
|
+
* **[@ckeditor/ckeditor5-restricted-editing](https://www.npmjs.com/package/@ckeditor/ckeditor5-restricted-editing)**: closes [#13029](https://github.com/ckeditor/ckeditor5/issues/13029). ([commit](https://github.com/ckeditor/ckeditor5/commit/521078075b09f3f9378cc946ef6e57492aa32dec))
|
116
|
+
* **[@ckeditor/ckeditor5-source-editing](https://www.npmjs.com/package/@ckeditor/ckeditor5-source-editing)**: closes [#13030](https://github.com/ckeditor/ckeditor5/issues/13030). ([commit](https://github.com/ckeditor/ckeditor5/commit/bfe944ca9885e63407bdd67c55b3be60015f08ab))
|
117
|
+
* **[@ckeditor/ckeditor5-special-characters](https://www.npmjs.com/package/@ckeditor/ckeditor5-special-characters)**: closes [#13031](https://github.com/ckeditor/ckeditor5/issues/13031). ([commit](https://github.com/ckeditor/ckeditor5/commit/a195c6047e6f06f2402ce1b60eb1278472a511b2))
|
118
|
+
* **[@ckeditor/ckeditor5-style](https://www.npmjs.com/package/@ckeditor/ckeditor5-style)**: closes [#13032](https://github.com/ckeditor/ckeditor5/issues/13032). ([commit](https://github.com/ckeditor/ckeditor5/commit/b93dfa123390d836a37f9eaca8e4b3232db68e11))
|
119
|
+
* **[@ckeditor/ckeditor5-table](https://www.npmjs.com/package/@ckeditor/ckeditor5-table)**: closes [#13033](https://github.com/ckeditor/ckeditor5/issues/13033). ([commit](https://github.com/ckeditor/ckeditor5/commit/d634c413763a7b47840be096712359f0c0d0a97a))
|
120
|
+
* **[@ckeditor/ckeditor5-watchdog](https://www.npmjs.com/package/@ckeditor/ckeditor5-watchdog)**: closes [#13035](https://github.com/ckeditor/ckeditor5/issues/13035). ([commit](https://github.com/ckeditor/ckeditor5/commit/f42bedbe2cfedf43453e539ec3de03e84b1c2825))
|
121
|
+
* **[@ckeditor/ckeditor5-collaboration-core](https://www.npmjs.com/package/@ckeditor/ckeditor5-collaboration-core)**
|
122
|
+
* **[@ckeditor/ckeditor5-comments](https://www.npmjs.com/package/@ckeditor/ckeditor5-comments)**
|
123
|
+
* **[@ckeditor/ckeditor5-export-pdf](https://www.npmjs.com/package/@ckeditor/ckeditor5-export-pdf)**
|
124
|
+
* **[@ckeditor/ckeditor5-export-word](https://www.npmjs.com/package/@ckeditor/ckeditor5-export-word)**
|
125
|
+
* **[@ckeditor/ckeditor5-import-word](https://www.npmjs.com/package/@ckeditor/ckeditor5-import-word)**
|
126
|
+
* **[@ckeditor/ckeditor5-operations-compressor](https://www.npmjs.com/package/@ckeditor/ckeditor5-operations-compressor)**
|
127
|
+
* **[@ckeditor/ckeditor5-pagination](https://www.npmjs.com/package/@ckeditor/ckeditor5-pagination)**
|
128
|
+
* **[@ckeditor/ckeditor5-real-time-collaboration](https://www.npmjs.com/package/@ckeditor/ckeditor5-real-time-collaboration)**
|
129
|
+
* **[@ckeditor/ckeditor5-revision-history](https://www.npmjs.com/package/@ckeditor/ckeditor5-revision-history)**
|
130
|
+
* **[@ckeditor/ckeditor5-track-changes](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes)**
|
131
|
+
* Updated translations. ([commit](https://github.com/ckeditor/ckeditor5/commit/6fd3eddd3869e2ca9831f358dc97a101cef88882))
|
132
|
+
|
133
|
+
### Released packages
|
134
|
+
|
135
|
+
Check out the [Versioning policy](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html) guide for more information.
|
136
|
+
|
137
|
+
<details>
|
138
|
+
<summary>Released packages (summary)</summary>
|
139
|
+
|
140
|
+
New packages:
|
141
|
+
|
142
|
+
* [@ckeditor/ckeditor5-build-multi-root](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-multi-root): v37.0.0
|
143
|
+
* [@ckeditor/ckeditor5-editor-multi-root](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-multi-root): v37.0.0
|
144
|
+
|
145
|
+
Minor releases (contain minor breaking changes):
|
146
|
+
|
147
|
+
* [@ckeditor/ckeditor5-table](https://www.npmjs.com/package/@ckeditor/ckeditor5-table): v36.0.1 => v37.0.0
|
148
|
+
|
149
|
+
Releases containing new features:
|
150
|
+
|
151
|
+
* [@ckeditor/ckeditor5-core](https://www.npmjs.com/package/@ckeditor/ckeditor5-core): v36.0.1 => v37.0.0
|
152
|
+
* [@ckeditor/ckeditor5-editor-balloon](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-balloon): v36.0.1 => v37.0.0
|
153
|
+
* [@ckeditor/ckeditor5-editor-classic](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-classic): v36.0.1 => v37.0.0
|
154
|
+
* [@ckeditor/ckeditor5-editor-decoupled](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-decoupled): v36.0.1 => v37.0.0
|
155
|
+
* [@ckeditor/ckeditor5-editor-inline](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-inline): v36.0.1 => v37.0.0
|
156
|
+
* [@ckeditor/ckeditor5-engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine): v36.0.1 => v37.0.0
|
157
|
+
* [@ckeditor/ckeditor5-enter](https://www.npmjs.com/package/@ckeditor/ckeditor5-enter): v36.0.1 => v37.0.0
|
158
|
+
* [@ckeditor/ckeditor5-find-and-replace](https://www.npmjs.com/package/@ckeditor/ckeditor5-find-and-replace): v36.0.1 => v37.0.0
|
159
|
+
* [@ckeditor/ckeditor5-image](https://www.npmjs.com/package/@ckeditor/ckeditor5-image): v36.0.1 => v37.0.0
|
160
|
+
* [@ckeditor/ckeditor5-mention](https://www.npmjs.com/package/@ckeditor/ckeditor5-mention): v36.0.1 => v37.0.0
|
161
|
+
* [@ckeditor/ckeditor5-typing](https://www.npmjs.com/package/@ckeditor/ckeditor5-typing): v36.0.1 => v37.0.0
|
162
|
+
* [@ckeditor/ckeditor5-ui](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui): v36.0.1 => v37.0.0
|
163
|
+
* [@ckeditor/ckeditor5-utils](https://www.npmjs.com/package/@ckeditor/ckeditor5-utils): v36.0.1 => v37.0.0
|
164
|
+
* [@ckeditor/ckeditor5-widget](https://www.npmjs.com/package/@ckeditor/ckeditor5-widget): v36.0.1 => v37.0.0
|
165
|
+
|
166
|
+
Other releases:
|
167
|
+
|
168
|
+
* [@ckeditor/ckeditor5-adapter-ckfinder](https://www.npmjs.com/package/@ckeditor/ckeditor5-adapter-ckfinder): v36.0.1 => v37.0.0
|
169
|
+
* [@ckeditor/ckeditor5-alignment](https://www.npmjs.com/package/@ckeditor/ckeditor5-alignment): v36.0.1 => v37.0.0
|
170
|
+
* [@ckeditor/ckeditor5-autoformat](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat): v36.0.1 => v37.0.0
|
171
|
+
* [@ckeditor/ckeditor5-autosave](https://www.npmjs.com/package/@ckeditor/ckeditor5-autosave): v36.0.1 => v37.0.0
|
172
|
+
* [@ckeditor/ckeditor5-basic-styles](https://www.npmjs.com/package/@ckeditor/ckeditor5-basic-styles): v36.0.1 => v37.0.0
|
173
|
+
* [@ckeditor/ckeditor5-block-quote](https://www.npmjs.com/package/@ckeditor/ckeditor5-block-quote): v36.0.1 => v37.0.0
|
174
|
+
* [@ckeditor/ckeditor5-build-balloon](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon): v36.0.1 => v37.0.0
|
175
|
+
* [@ckeditor/ckeditor5-build-balloon-block](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon-block): v36.0.1 => v37.0.0
|
176
|
+
* [@ckeditor/ckeditor5-build-classic](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic): v36.0.1 => v37.0.0
|
177
|
+
* [@ckeditor/ckeditor5-build-decoupled-document](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-decoupled-document): v36.0.1 => v37.0.0
|
178
|
+
* [@ckeditor/ckeditor5-build-inline](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-inline): v36.0.1 => v37.0.0
|
179
|
+
* [@ckeditor/ckeditor5-ckbox](https://www.npmjs.com/package/@ckeditor/ckeditor5-ckbox): v36.0.1 => v37.0.0
|
180
|
+
* [@ckeditor/ckeditor5-ckfinder](https://www.npmjs.com/package/@ckeditor/ckeditor5-ckfinder): v36.0.1 => v37.0.0
|
181
|
+
* [@ckeditor/ckeditor5-clipboard](https://www.npmjs.com/package/@ckeditor/ckeditor5-clipboard): v36.0.1 => v37.0.0
|
182
|
+
* [@ckeditor/ckeditor5-cloud-services](https://www.npmjs.com/package/@ckeditor/ckeditor5-cloud-services): v36.0.1 => v37.0.0
|
183
|
+
* [@ckeditor/ckeditor5-code-block](https://www.npmjs.com/package/@ckeditor/ckeditor5-code-block): v36.0.1 => v37.0.0
|
184
|
+
* [@ckeditor/ckeditor5-collaboration-core](https://www.npmjs.com/package/@ckeditor/ckeditor5-collaboration-core): v36.0.1 => v37.0.0
|
185
|
+
* [@ckeditor/ckeditor5-comments](https://www.npmjs.com/package/@ckeditor/ckeditor5-comments): v36.0.1 => v37.0.0
|
186
|
+
* [@ckeditor/ckeditor5-easy-image](https://www.npmjs.com/package/@ckeditor/ckeditor5-easy-image): v36.0.1 => v37.0.0
|
187
|
+
* [@ckeditor/ckeditor5-essentials](https://www.npmjs.com/package/@ckeditor/ckeditor5-essentials): v36.0.1 => v37.0.0
|
188
|
+
* [@ckeditor/ckeditor5-export-pdf](https://www.npmjs.com/package/@ckeditor/ckeditor5-export-pdf): v36.0.1 => v37.0.0
|
189
|
+
* [@ckeditor/ckeditor5-export-word](https://www.npmjs.com/package/@ckeditor/ckeditor5-export-word): v36.0.1 => v37.0.0
|
190
|
+
* [@ckeditor/ckeditor5-font](https://www.npmjs.com/package/@ckeditor/ckeditor5-font): v36.0.1 => v37.0.0
|
191
|
+
* [@ckeditor/ckeditor5-heading](https://www.npmjs.com/package/@ckeditor/ckeditor5-heading): v36.0.1 => v37.0.0
|
192
|
+
* [@ckeditor/ckeditor5-highlight](https://www.npmjs.com/package/@ckeditor/ckeditor5-highlight): v36.0.1 => v37.0.0
|
193
|
+
* [@ckeditor/ckeditor5-horizontal-line](https://www.npmjs.com/package/@ckeditor/ckeditor5-horizontal-line): v36.0.1 => v37.0.0
|
194
|
+
* [@ckeditor/ckeditor5-html-embed](https://www.npmjs.com/package/@ckeditor/ckeditor5-html-embed): v36.0.1 => v37.0.0
|
195
|
+
* [@ckeditor/ckeditor5-html-support](https://www.npmjs.com/package/@ckeditor/ckeditor5-html-support): v36.0.1 => v37.0.0
|
196
|
+
* [@ckeditor/ckeditor5-import-word](https://www.npmjs.com/package/@ckeditor/ckeditor5-import-word): v36.0.1 => v37.0.0
|
197
|
+
* [@ckeditor/ckeditor5-indent](https://www.npmjs.com/package/@ckeditor/ckeditor5-indent): v36.0.1 => v37.0.0
|
198
|
+
* [@ckeditor/ckeditor5-language](https://www.npmjs.com/package/@ckeditor/ckeditor5-language): v36.0.1 => v37.0.0
|
199
|
+
* [@ckeditor/ckeditor5-link](https://www.npmjs.com/package/@ckeditor/ckeditor5-link): v36.0.1 => v37.0.0
|
200
|
+
* [@ckeditor/ckeditor5-list](https://www.npmjs.com/package/@ckeditor/ckeditor5-list): v36.0.1 => v37.0.0
|
201
|
+
* [@ckeditor/ckeditor5-markdown-gfm](https://www.npmjs.com/package/@ckeditor/ckeditor5-markdown-gfm): v36.0.1 => v37.0.0
|
202
|
+
* [@ckeditor/ckeditor5-media-embed](https://www.npmjs.com/package/@ckeditor/ckeditor5-media-embed): v36.0.1 => v37.0.0
|
203
|
+
* [@ckeditor/ckeditor5-minimap](https://www.npmjs.com/package/@ckeditor/ckeditor5-minimap): v36.0.1 => v37.0.0
|
204
|
+
* [@ckeditor/ckeditor5-operations-compressor](https://www.npmjs.com/package/@ckeditor/ckeditor5-operations-compressor): v36.0.1 => v37.0.0
|
205
|
+
* [@ckeditor/ckeditor5-page-break](https://www.npmjs.com/package/@ckeditor/ckeditor5-page-break): v36.0.1 => v37.0.0
|
206
|
+
* [@ckeditor/ckeditor5-pagination](https://www.npmjs.com/package/@ckeditor/ckeditor5-pagination): v36.0.1 => v37.0.0
|
207
|
+
* [@ckeditor/ckeditor5-paragraph](https://www.npmjs.com/package/@ckeditor/ckeditor5-paragraph): v36.0.1 => v37.0.0
|
208
|
+
* [@ckeditor/ckeditor5-paste-from-office](https://www.npmjs.com/package/@ckeditor/ckeditor5-paste-from-office): v36.0.1 => v37.0.0
|
209
|
+
* [@ckeditor/ckeditor5-real-time-collaboration](https://www.npmjs.com/package/@ckeditor/ckeditor5-real-time-collaboration): v36.0.1 => v37.0.0
|
210
|
+
* [@ckeditor/ckeditor5-remove-format](https://www.npmjs.com/package/@ckeditor/ckeditor5-remove-format): v36.0.1 => v37.0.0
|
211
|
+
* [@ckeditor/ckeditor5-restricted-editing](https://www.npmjs.com/package/@ckeditor/ckeditor5-restricted-editing): v36.0.1 => v37.0.0
|
212
|
+
* [@ckeditor/ckeditor5-revision-history](https://www.npmjs.com/package/@ckeditor/ckeditor5-revision-history): v36.0.1 => v37.0.0
|
213
|
+
* [@ckeditor/ckeditor5-select-all](https://www.npmjs.com/package/@ckeditor/ckeditor5-select-all): v36.0.1 => v37.0.0
|
214
|
+
* [@ckeditor/ckeditor5-source-editing](https://www.npmjs.com/package/@ckeditor/ckeditor5-source-editing): v36.0.1 => v37.0.0
|
215
|
+
* [@ckeditor/ckeditor5-special-characters](https://www.npmjs.com/package/@ckeditor/ckeditor5-special-characters): v36.0.1 => v37.0.0
|
216
|
+
* [@ckeditor/ckeditor5-style](https://www.npmjs.com/package/@ckeditor/ckeditor5-style): v36.0.1 => v37.0.0
|
217
|
+
* [@ckeditor/ckeditor5-theme-lark](https://www.npmjs.com/package/@ckeditor/ckeditor5-theme-lark): v36.0.1 => v37.0.0
|
218
|
+
* [@ckeditor/ckeditor5-track-changes](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes): v36.0.1 => v37.0.0
|
219
|
+
* [@ckeditor/ckeditor5-undo](https://www.npmjs.com/package/@ckeditor/ckeditor5-undo): v36.0.1 => v37.0.0
|
220
|
+
* [@ckeditor/ckeditor5-upload](https://www.npmjs.com/package/@ckeditor/ckeditor5-upload): v36.0.1 => v37.0.0
|
221
|
+
* [@ckeditor/ckeditor5-watchdog](https://www.npmjs.com/package/@ckeditor/ckeditor5-watchdog): v36.0.1 => v37.0.0
|
222
|
+
* [@ckeditor/ckeditor5-word-count](https://www.npmjs.com/package/@ckeditor/ckeditor5-word-count): v36.0.1 => v37.0.0
|
223
|
+
* [@ckeditor/letters](https://www.npmjs.com/package/@ckeditor/letters): v36.0.1 => v37.0.0
|
224
|
+
* [ckeditor5-collaboration](https://www.npmjs.com/package/ckeditor5-collaboration): v36.0.1 => v37.0.0
|
225
|
+
</details>
|
226
|
+
|
227
|
+
|
228
|
+
## [37.0.0-rc.0](https://github.com/ckeditor/ckeditor5/compare/v36.0.1...v37.0.0-rc.0) (2023-04-03)
|
9
229
|
|
10
230
|
### MAJOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
|
11
231
|
|
@@ -25,6 +245,7 @@ Changelog
|
|
25
245
|
* **[engine](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine)**: Introduced `Differ.getChangedRoots()` which returns the roots added or detached since last the differ reset. `Differ#isEmpty` and `Differ#hasDataChanges()` will return `true` if a root was added or detached. ([commit](https://github.com/ckeditor/ckeditor5/commit/927df409f73c7018eb5a34a9908daab9cc4f9946))
|
26
246
|
* **[mention](https://www.npmjs.com/package/@ckeditor/ckeditor5-mention)**: Limiting the dropdown on the singular feed level should now be possible. Closes [#13504](https://github.com/ckeditor/ckeditor5/issues/13504). ([commit](https://github.com/ckeditor/ckeditor5/commit/489b3fda402504cb0492fceb368af475c8dd85b6))
|
27
247
|
* **[multi-root-editor](https://www.npmjs.com/package/@ckeditor/ckeditor5-multi-root-editor)**: Introduced the multi-root editor type that allows defining multiple editable areas handled by a single editor instance. Closes [#11493](https://github.com/ckeditor/ckeditor5/issues/11493). ([commit](https://github.com/ckeditor/ckeditor5/commit/50b9c4fe3dd8e22668f36c06af6cdc7af73d81cf))
|
248
|
+
* **[real-time-collaboration](https://www.npmjs.com/package/@ckeditor/ckeditor5-real-time-collaboration)**: Added support for custom path prefixes in WebSocket URLs. Any path proceeding the required `/ws` part in the WebSocket URL is now preserved.
|
28
249
|
|
29
250
|
### Bug fixes
|
30
251
|
|
package/README.md
CHANGED
@@ -9,34 +9,38 @@ CKEditor 5 [](http://eepurl.com/c3zRPr)
|
10
10
|
[](https://twitter.com/ckeditor)
|
11
11
|
|
12
|
-
CKEditor 5 is an ultra-modern JavaScript rich
|
12
|
+
CKEditor 5 is an ultra-modern JavaScript rich-text editor with MVC architecture, a custom data model, and virtual DOM. It is written from scratch in TypeScript and has excellent webpack and Vite support. It provides every type of WYSIWYG editing solution imaginable with extensive collaboration support. From editors similar to Google Docs and Medium to Slack or Twitter-like applications, all is possible within a single editing framework. As a market leader, it is constantly expanded and updated.
|
13
13
|
|
14
14
|

|
15
15
|
|
16
16
|
## Table of contents
|
17
17
|
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
18
|
+
- [CKEditor 5 ](#ckeditor-5-)
|
19
|
+
- [Table of contents](#table-of-contents)
|
20
|
+
- [Quick start](#quick-start)
|
21
|
+
- [CKEditor 5 online builder](#ckeditor-5-online-builder)
|
22
|
+
- [CKEditor 5 predefined builds](#ckeditor-5-predefined-builds)
|
23
|
+
- [Example installation](#example-installation)
|
24
|
+
- [CKEditor 5 advanced installation](#ckeditor-5-advanced-installation)
|
25
|
+
- [CKEditor 5 Framework](#ckeditor-5-framework)
|
26
|
+
- [Documentation and FAQ](#documentation-and-faq)
|
27
|
+
- [Releases](#releases)
|
28
|
+
- [Editing and collaboration features](#editing-and-collaboration-features)
|
29
|
+
- [Contributing and project organization](#contributing-and-project-organization)
|
30
|
+
- [Ideas and discussions](#ideas-and-discussions)
|
31
|
+
- [Development](#development)
|
32
|
+
- [Reporting issues and feature requests](#reporting-issues-and-feature-requests)
|
33
|
+
- [License](#license)
|
30
34
|
|
31
35
|
## Quick start
|
32
36
|
|
33
|
-
### CKEditor 5
|
37
|
+
### CKEditor 5 online builder
|
34
38
|
|
35
|
-
The
|
39
|
+
The easiest way to start using CKEditor 5 with all the features you need, is to prepare a customized build with the [online builder](https://ckeditor.com/ckeditor-5/online-builder/). All you need to do is choose the preferred predefined build as a base, add all the required plugins, and download the ready-to-use package. Refer to the [Online builder Quick start](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start.html#creating-custom-builds-with-online-builder) guide to follow this installation path.
|
36
40
|
|
37
41
|
### CKEditor 5 predefined builds
|
38
42
|
|
39
|
-
CKEditor 5 predefined builds are a set of ready-to-use rich text editors. Every
|
43
|
+
CKEditor 5 predefined builds are a set of ready-to-use rich text editors. Every build provides a single type of editor with a set of features and a default configuration.
|
40
44
|
|
41
45
|
The following CKEditor 5 predefined builds are currently available:
|
42
46
|
|
@@ -53,54 +57,60 @@ Creating an editor using a CKEditor 5 build is very simple and can be described
|
|
53
57
|
1. Load the desired editor via the `<script>` tag.
|
54
58
|
2. Call the static `create()` method to create the editor.
|
55
59
|
|
56
|
-
In your HTML page add an element that CKEditor should replace:
|
60
|
+
In your HTML page, add an element that CKEditor should replace:
|
57
61
|
|
58
62
|
```html
|
59
63
|
<div id="editor"></div>
|
60
64
|
```
|
61
65
|
|
62
|
-
Load the classic editor build (you can choose between [CDN](https://cdn.ckeditor.com/#ckeditor5), [npm](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#npm) and [zip downloads](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#zip-download)):
|
66
|
+
Load the classic editor build (you can choose between the [CDN](https://cdn.ckeditor.com/#ckeditor5), [npm](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#npm), and [zip downloads](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#zip-download)):
|
63
67
|
|
64
68
|
```html
|
65
|
-
<script src="https://cdn.ckeditor.com/ckeditor5/
|
69
|
+
<script src="https://cdn.ckeditor.com/ckeditor5/37.0.0/classic/ckeditor.js"></script>
|
66
70
|
```
|
67
71
|
|
68
72
|
Call the [`ClassicEditor.create()`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-classic_classiceditor-ClassicEditor.html#static-function-create) method:
|
69
73
|
|
70
74
|
```html
|
71
75
|
<script>
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
76
|
+
ClassicEditor
|
77
|
+
.create( document.querySelector( '#editor' ) )
|
78
|
+
.catch( error => {
|
79
|
+
console.error( error );
|
80
|
+
} );
|
77
81
|
</script>
|
78
82
|
```
|
79
83
|
|
80
84
|
You’re ready to go!
|
81
85
|
|
82
|
-
To find out how to start with other builds check the [Predefined builds](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html) guide in the CKEditor 5 documentation.
|
86
|
+
To find out how to start with other builds, check the [Predefined builds](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html) guide in the CKEditor 5 documentation.
|
83
87
|
|
84
88
|
### CKEditor 5 advanced installation
|
85
89
|
|
86
|
-
For more advanced users
|
90
|
+
For more advanced users or those who need to integrate CKEditor 5 with their applications, we have prepared several other, advanced methods to do it. You can:
|
91
|
+
* Integrate the editor from source [using webpack](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/integrating-from-source-webpack.html) or [Vite](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/integrating-from-source-vite.html)
|
92
|
+
* Use [DLL builds](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/dll-builds.html)
|
93
|
+
* Use some of the pre-made integrations with popular [JavaScript frameworks](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/overview.html):
|
94
|
+
* [Angular](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/angular.html)
|
95
|
+
* [React](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/react.html)
|
96
|
+
* [Vue](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/vuejs-v3.html)
|
87
97
|
|
88
98
|
#### CKEditor 5 Framework
|
89
99
|
|
90
100
|
CKEditor 5 builds allow you to quickly and easily initialize one of the many types of editors in your application. At the same time, CKEditor 5 is also a framework for creating custom-made rich text editing solutions.
|
91
101
|
|
92
|
-
To find out how to start building your
|
102
|
+
To find out how to start building your editor from scratch go to the [CKEditor 5 Framework overview](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html) section of the CKEditor 5 documentation.
|
93
103
|
|
94
104
|
## Documentation and FAQ
|
95
105
|
|
96
|
-
|
106
|
+
Extensive documentation dedicated to all things CKEditor 5-related is available. You will find basic guides that will help you kick off your project, advanced deep-dive tutorials to tailor the editor to your specific needs, and help sections with solutions and answers to any of your possible questions. To find out more refer to the following [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/index.html) sections:
|
97
107
|
|
98
108
|
* [Installing CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/installation/index.html)
|
99
|
-
* [CKEditor 5 features
|
109
|
+
* [CKEditor 5 features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html)
|
100
110
|
* [CKEditor 5 examples](https://ckeditor.com/docs/ckeditor5/latest/examples/index.html)
|
101
111
|
* [Updating CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/updating/index.html)
|
102
112
|
* [Getting CKEditor 5 support](https://ckeditor.com/docs/ckeditor5/latest/support/index.html)
|
103
|
-
* [CKEditor 5 Framework
|
113
|
+
* [CKEditor 5 Framework](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html)
|
104
114
|
* [API documentation](https://ckeditor.com/docs/ckeditor5/latest/api/index.html)
|
105
115
|
|
106
116
|
For FAQ please go to the [CKEditor Ecosystem help center](https://support.ckeditor.com/hc/en-us).
|
@@ -112,11 +122,11 @@ Follow the [CKEditor 5 changelog](https://github.com/ckeditor/ckeditor5/blob/sta
|
|
112
122
|
|
113
123
|
## Editing and collaboration features
|
114
124
|
|
115
|
-
The CKEditor 5 Framework offers access to plethora of various plugins, supporting [all kinds of editing features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html).
|
125
|
+
The CKEditor 5 Framework offers access to a plethora of various plugins, supporting [all kinds of editing features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html).
|
116
126
|
|
117
|
-
From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily
|
127
|
+
From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily extensible and customizable. Special duty features like Markdown input and output and source editing, or export to PDF and Word provide solutions for users with diverse and specialized needs. Images and videos are easily supported and CKEditor 5 offers various upload and storage systems to manage these.
|
118
128
|
|
119
|
-
The number of options and the
|
129
|
+
The number of options and the ease of customization and adding new ones make the editing experience even better for any environment and professional background.
|
120
130
|
|
121
131
|
Refer to the [CKEditor 5 Features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html) documentation for details.
|
122
132
|
|
@@ -136,9 +146,7 @@ See the [official contributors' guide](https://ckeditor.com/docs/ckeditor5/lates
|
|
136
146
|
|
137
147
|
### Reporting issues and feature requests
|
138
148
|
|
139
|
-
|
140
|
-
|
141
|
-
Read more on the [Getting support](https://ckeditor.com/docs/ckeditor5/latest/support/getting-support.html) guide.
|
149
|
+
Report issues in [the `ckeditor5` repository](https://github.com/ckeditor/ckeditor5/issues). Read more on the [Getting support](https://ckeditor.com/docs/ckeditor5/latest/support/getting-support.html) guide.
|
142
150
|
|
143
151
|
## License
|
144
152
|
|