What is @ckeditor/ckeditor5-editor-multi-root?
@ckeditor/ckeditor5-editor-multi-root is a package that provides a multi-root editor implementation for CKEditor 5. This allows you to create an editor instance that can manage multiple editable areas (roots) within a single editor instance. This is particularly useful for complex applications where you need to manage multiple content areas simultaneously.
What are @ckeditor/ckeditor5-editor-multi-root's main functionalities?
Creating a Multi-Root Editor
This code demonstrates how to create a multi-root editor instance with two editable areas: 'header' and 'content'. The editor is initialized with these two roots, allowing you to manage both areas within a single editor instance.
const MultiRootEditor = require('@ckeditor/ckeditor5-editor-multi-root/src/multirooteditor');
const ClassicEditor = require('@ckeditor/ckeditor5-editor-classic/src/classiceditor');
MultiRootEditor.create({
header: document.querySelector('#header'),
content: document.querySelector('#content')
}).then(editor => {
console.log('Editor was initialized', editor);
}).catch(error => {
console.error(error.stack);
});
Adding Plugins to Multi-Root Editor
This code sample shows how to add plugins to the multi-root editor. In this example, the Essentials, Paragraph, and Bold plugins are added, and the toolbar is configured to include the 'bold' button.
const MultiRootEditor = require('@ckeditor/ckeditor5-editor-multi-root/src/multirooteditor');
const Essentials = require('@ckeditor/ckeditor5-essentials/src/essentials');
const Paragraph = require('@ckeditor/ckeditor5-paragraph/src/paragraph');
const Bold = require('@ckeditor/ckeditor5-basic-styles/src/bold');
MultiRootEditor.create({
header: document.querySelector('#header'),
content: document.querySelector('#content')
}, {
plugins: [ Essentials, Paragraph, Bold ],
toolbar: [ 'bold' ]
}).then(editor => {
console.log('Editor with plugins was initialized', editor);
}).catch(error => {
console.error(error.stack);
});
Accessing and Modifying Editor Data
This code demonstrates how to access and modify the data in different roots of the multi-root editor. You can get the data from a specific root and set new data for a specific root.
const MultiRootEditor = require('@ckeditor/ckeditor5-editor-multi-root/src/multirooteditor');
MultiRootEditor.create({
header: document.querySelector('#header'),
content: document.querySelector('#content')
}).then(editor => {
// Accessing data
const headerData = editor.getData({ rootName: 'header' });
const contentData = editor.getData({ rootName: 'content' });
console.log('Header Data:', headerData);
console.log('Content Data:', contentData);
// Modifying data
editor.setData('<p>New header content</p>', { rootName: 'header' });
editor.setData('<p>New content area</p>', { rootName: 'content' });
}).catch(error => {
console.error(error.stack);
});
Other packages similar to @ckeditor/ckeditor5-editor-multi-root
quill
Quill is a modern WYSIWYG editor built for compatibility and extensibility. While it does not natively support multi-root editing, it offers a highly customizable and extensible architecture that can be adapted for complex use cases. Compared to @ckeditor/ckeditor5-editor-multi-root, Quill is more lightweight but may require additional customization for multi-root functionality.
tinymce
TinyMCE is a popular rich text editor that provides a wide range of features and plugins. It supports multiple instances of editors on the same page but does not natively support a single editor instance managing multiple roots. TinyMCE is highly configurable and offers extensive documentation and community support, making it a robust alternative to @ckeditor/ckeditor5-editor-multi-root for many use cases.
draft-js
Draft.js is a JavaScript rich text editor framework, built for React. It provides a lot of flexibility and control over the editor's behavior and appearance. While it does not offer out-of-the-box multi-root editing, its modular architecture allows developers to implement custom solutions for managing multiple content areas. Draft.js is more of a framework than a ready-to-use editor, offering more control at the cost of requiring more development effort.
43.1.0 (September 5, 2024)
We are happy to announce the release of CKEditor 5 v43.1.0.
Release highlights
This release includes important bug fixes and enhancements for the editor:
-
Block merge fields: In contrast to regular, inline merge fields, the block merge fields are designed to represent complex, block-level structures, such as a dynamically generated table, a row of products, or a personalized call-to-action segment. Block merge fields are supposed to be replaced by arbitrary HTML data when the document template is post-processed or exported to a PDF or Word file.
-
Nested dropdown menus: this release introduces a new UI component: nested dropdown menus. They can be used by feature developers to easily provide an advanced user interface where UI elements are organized into a nested menu structure.
-
Customizable accessible label: You can now configure the label for the accessible editable area through the editor settings, ensuring it fits your system’s needs.
-
Improved table and cell border controls: It is now easier to manage both table and cell borders. The table user interface now clearly indicates the default border settings, allowing you to set “no borders” (None
) for tables and cells without any additional configuration.
⚠️ In some cases this update may lead to data changes in the tables’ HTML markup when the editor loads them. However, visually nothing will change, and the experience will be the same.
The full list of enhancements can be found below.