@ckeditor/ckeditor5-build-multi-root

CKEditor 5 multi-root editor build

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

Documentation

See:

• Installation for how to install this package and what it contains.
• Editor lifecycle for how to create an editor and interact with it.
• Configuration for how to configure the editor.
• Creating custom builds for how to customize the build (configure and rebuild the editor bundle).

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-multi-root

And use it in your website:

<div id="toolbar"></div>
<div id="header">
	<p>Content for header.</p>
</div>
<div id="content">
	<p>Main editor content.</p>
</div>
<div class="boxes">
	<div class="box box-left editor">
		<div id="left-side">
			<p>Content for left-side box.</p>
		</div>
	</div>
	<div class="box box-right editor">
		<div id="right-side">
			<p>Content for right-side box.</p>
		</div>
	</div>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-multi-root/build/ckeditor.js"></script>
<script>
	MultiRootEditor
			.create( {
				header: document.getElementById( 'header' ),
				content: document.getElementById( 'content' ),
				leftSide: document.getElementById( 'left-side' ),
				rightSide: document.getElementById( 'right-side' )
			} )
			.then( editor => {
				window.editor = editor;

				// Append toolbar to a proper container.
				const toolbarContainer = document.getElementById( 'toolbar' );
				toolbarContainer.appendChild( editor.ui.view.toolbar.element );
			} )
			.catch( error => {
				console.error( 'There was a problem initializing the editor.', error );
			} );
</script>

Or in your JavaScript application:

import MultiRootEditor from '@ckeditor/ckeditor5-build-multi-root';

// Or using the CommonJS version:
// const MultiRootEditor = require( '@ckeditor/ckeditor5-build-multi-root' );

MultiRootEditor
	.create( {
		header: document.getElementById( 'header' ),
		content: document.getElementById( 'content' ),
		leftSide: document.getElementById( 'left-side' ),
		rightSide: document.getElementById( 'right-side' )
	} )
	.then( editor => {
		window.editor = editor;

		// Append toolbar to a proper container.
		const toolbarContainer = document.getElementById( 'toolbar' );
		toolbarContainer.appendChild( editor.ui.view.toolbar.element );
	} )
	.catch( error => {
		console.error( 'There was a problem initializing the editor.', error );
	} );

Note: If you are planning to integrate CKEditor 5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js). Read more in the Advanced setup guide.

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.1.0 (December 16, 2024)

We are pleased to announce the latest CKEditor 5 release, focusing on performance enhancements and key bug fixes to improve your editing and collaboration experience.

Release Highlights

⚡ Performance enhancements: Part 3

This release introduces another set of performance related improvements, focused on faster editor initialization for huge documents. The initialization time was lowered by further 15% to 45%, depending on the tested sample.

The combined improvements introduced in recent releases amount to around 65%-80% lower loading time in total, which means the editor will load 3-5x faster. As the gain is not linear, bigger documents see even better improvement (more than 10x faster).

Moreover, all these improvements positively impact document save time (editor.getData()), which should help with autosave issues, among others.

We still actively work in this area, so you may expect even more editor load and save efficiency improvements in the upcoming releases.

🔨 Bug Fixes and improvements

• Comments enhancements:
  • Data export options: We introduced the showCommentHighlights option in editor.getData(), that changes the comment marker conversion, allowing for styling comments in the output. Perfect for showing what was commented in Export to PDF, for example.
  • Inline mode improvements: We addressed a problem where comment annotations in inline mode did not close properly when clicking elsewhere in the content.
  • Thread management: We resolved an issue where creating a new thread was not interrupted when the corresponding marker was removed from the content, ensuring better stability during collaborative editing.
• Revision History update:
  • Restore functionality: We disabled the ability to restore the current (edited, not saved) revision, as it represents current content, so there is nothing to restore. At the same time, using it led to some non-obvious behaviors.
• Image handling: We resolved an issue where images in the uploading state could be deleted when dragged and dropped within the editor. Keep dragging, even when it is not there 🙈.

🎄 Happy holidays!

As the holiday season approaches, we extend our warmest wishes to our community and users. Thank you for your continued support, and we look forward to bringing you further enhancements and exciting features in the coming year.