@ckeditor/ckeditor5-editor-multi-root

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.

README

CKEditor 5 multi-root editor implementation

The multi-root editor implementation for CKEditor 5. Read more about the multi-root editor build and see the demo.

This package contains the MultiRootEditor class. Follow there to learn more about this type of editor and how to initialize it.

This package contains the source version of the multi-root editor. Read more about CKEditor 5 predefined builds in the CKEditor 5 documentation.

Documentation

See the @ckeditor/ckeditor5-editor-multi-root package page in CKEditor 5 documentation.

Installation

npm install ckeditor5

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

Changelog

44.0.0 (December 2, 2024)

Release Highlights

We are excited to introduce CKEditor 5 v44.0.0, a release packed with high impact updates designed to enhance your editing experience and simplify access to our premium offers. Here's what’s new:

🚀 Self-service plans: Simplified access to premium features

We are introducing flexible self-service plans that put you in control with full transparency. Now, you can:

• Choose the plan that fits your needs, pay only for what you use, and get started instantly with a commitment-free trial.
• Seamlessly manage your license keys, track usage, and more in the new Customer Portal.

💡 Important for current users:

If you are upgrading to v44.0.0+, ensure a smooth transition by updating your license keys in the editor, as we implemented a new format of the key. To get the new key, visit the Customer Portal. You can also refer to our license key and activation guide for help with logging in to the portal.

📣 The open-source licensing remains unchanged. However, config.licenseKey is now a required property in the editor configuration. Use 'GPL' for installations under the GPL terms. Read more in the update guide.

🔖 Bookmarks: Organize your content with ease

Say hello to Bookmarks, a long-awaited feature that simplifies content navigation within the editor. With this release, you can:

• Add anchors as reference points within text.
• Link to the newly created bookmarks in the editor to navigate to specific locations within complex documents, such as contracts or technical manuals.

📍 Future updates to Bookmarks and the linking experience are planned for the upcoming releases. Follow progress and share your feedback on GitHub.

⚡ Performance improvements: Faster table rendering

The current release includes another stride towards improving the performance aspect of the editor, this time focusing on how tables are handled in the content. Implemented optimizations have made table rendering 3x faster, with the average load time of a document with a very long, complex tables dropping from around 4.5 seconds to just 1.5 seconds.