@ckeditor/ckeditor5-restricted-editing

What is @ckeditor/ckeditor5-restricted-editing?

@ckeditor/ckeditor5-restricted-editing is a plugin for CKEditor 5 that allows you to restrict editing to specific parts of the content. This is useful for scenarios where you want to protect certain parts of the document from being modified by users while allowing them to edit other parts.

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

Enable Restricted Editing Mode

This code initializes the CKEditor with the Restricted Editing Mode plugin enabled. It adds the 'restrictedEditing' button to the toolbar, allowing users to toggle the restricted editing mode.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ RestrictedEditingMode, ... ], toolbar: [ 'restrictedEditing', ... ] })

Mark Editable Regions

This code marks a specific range in the document as an editable region. Users will be able to edit only within this range when the restricted editing mode is enabled.

editor.execute('restrictedEditingException', { commandParams: { range: editor.model.createRange(editor.model.createPositionAt(editor.model.document.getRoot(), 0), editor.model.createPositionAt(editor.model.document.getRoot(), 5)) } })

Toggle Restricted Editing Mode

This code toggles the restricted editing mode on or off. When enabled, users can only edit the marked editable regions.

editor.execute('restrictedEditing')

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

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. While it does not have a built-in restricted editing mode, it offers a modular architecture that allows developers to implement similar functionality through custom modules.

tinymce

TinyMCE is a popular rich text editor that provides a wide range of features and plugins. It does not have a direct equivalent to restricted editing mode, but it offers content protection features through its premium plugins.

prosemirror

ProseMirror is a toolkit for building rich text editors with a focus on extensibility and customizability. Developers can create custom plugins to implement restricted editing functionality similar to @ckeditor/ckeditor5-restricted-editing.

README

CKEditor 5 restricted editing feature

This package implements the restricted editing feature for CKEditor 5.

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 restricted editing feature guide.

Documentation

See the @ckeditor/ckeditor5-restricted-editing package page as well as the restricted 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.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.