CKEditor 5 v37.0.0 – officially a TypeScript rich text editor
Often releases are full of lots of small improvements, but the release of CKEditor v37.0.0 completes our months-long effort to migrate CKEditor to TypeScript. It also includes a feature update to the Comments plugin, with the addition of Archive functionality. Read on to find out more….
# TypeScript migration complete
# What are the benefits of a TypeScript editor?
The key benefit of being a TypeScript editor is that it provides an improved developer experience (DX) by making it easier to write type-safe code, better code completion and error checking in IDEs. These changes improve the overall code quality of CKEditor – giving it greater stability and lifting its performance.
For any developer who customizes the CKEditor code, the change to Typescript makes the CKEditor latest version:
- Simpler to write better, more reliable code
- Easier to maintain the code, especially when it comes to larger, longer, and more complex projects.
These DX improvements are made possible by an additional safety layer provided by the compiler, and an IDE that suggests types and autocompletes.
# Changes to expect for developers
While CKEditor remains unchanged for content authors, for professional developers and the community there are some changes worth mentioning:
- Your custom plugins don’t need to be updated, unless you plan to move them to TypeScript
- API documentation has actual and comprehensive TypeScript types
# Comments archive – feature update
The CKEditor 5 v37.0.0 release also contains a feature update to the Comments plugin. This new ‘archive’ functionality allows you to archive (or store/cache) the comments made, and takes the editor one step closer to being the ultimate collaborative rich text editor.
To remind you, before v37.0.0, it wasn’t possible to archive a comment or a comment thread, instead you had to permanently remove them, which led to the loss of (sometimes important) historical data. With this update, users can now archive comments – while still being able to view and restore those archived comments via the toolbar.
# Multi-root editor – progress update
Although full-blown multi-root editor support is still a work in progress, there are some improvements to report. In the CKEditor 5 v37.0.0 release, an official multi-root editor type and a new multi-root editor build were introduced.
Additionally, there are fundamental improvements which make the multi-root editor more flexible, making it possible for developers to build such instances that allows users to:
- Add or remove editing fields in your application in a dynamic fashion (i.e. after the editor was initialized), without the need to create additional editor instances.
- Use root attributes to store additional metadata related to roots (editable fields) to make it easier to further customize the editing experience according to your needs.
# What’s next for CKEditor latest version?
Following CKEditor 5 v37.0.0, a newer version, v37.1.0 was also released. This version introduces the exciting Productivity Pack, that includes five new Premium plugins:
- Slash Commands
- Format Painter
- Document Outline
- Table of Contents
If you’d like to learn more about the new Productivity Pack, please contact us.
# Breaking changes and other improvements
With Node.js v14 reaching the end of its long term support on April 30th 2023, the minimum required Node version has been upgraded to v16.
To ensure a smooth upgrade, please read the Update to CKEditor 5 v37.0.0 guide before updating your files. To see the full list of breaking changes as well as improvements, please refer to our release notes.
CKEditor 5 is available under Open Source and Commercial licenses. You can find all the details on our license page.