@ckeditor/ckeditor5-source-editing

What is @ckeditor/ckeditor5-source-editing?

@ckeditor/ckeditor5-source-editing is a plugin for CKEditor 5 that allows users to switch between the WYSIWYG editor and the source code view. This is particularly useful for users who need to edit the HTML source code directly.

What are @ckeditor/ckeditor5-source-editing's main functionalities?

Enable Source Editing

This code snippet demonstrates how to enable the Source Editing plugin in a CKEditor 5 instance. By adding the SourceEditing plugin to the extraPlugins array, users can toggle between the WYSIWYG editor and the source code view.

ClassicEditor.create(document.querySelector('#editor'), { extraPlugins: [ SourceEditing ] })

Toggle Source Editing Mode

This code snippet shows how to programmatically toggle the source editing mode in CKEditor 5. By executing the 'sourceEditing' command, the editor switches between the WYSIWYG view and the source code view.

editor.execute('sourceEditing');

Other packages similar to @ckeditor/ckeditor5-source-editing

tinymce

TinyMCE is a popular WYSIWYG HTML editor that also offers a source code editing mode. It provides a similar feature set to @ckeditor/ckeditor5-source-editing, allowing users to switch between visual and code views.

quill

Quill is another WYSIWYG editor that supports source code editing through extensions. While it is not as feature-rich as CKEditor 5, it provides a lightweight alternative for basic source code editing needs.

froala-editor

Froala Editor is a lightweight WYSIWYG editor that includes a source code view feature. It offers a similar user experience to @ckeditor/ckeditor5-source-editing, with a focus on ease of use and performance.

README

CKEditor 5 source editing feature

This package implements the source editing support for CKEditor 5 that allows you to view and edit the source of the document.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Demo

Check out the demo in the source editing feature guide.

Documentation

See the @ckeditor/ckeditor5-source-editing package page as well as the source editing feature guide in the CKEditor 5 documentation.

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.