CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 5/Features

Comments-only mode

In the comments-only mode, you can create, edit, and remove comments but you are unable to change the document content.

# Enabling comments-only mode

The recommended way to enable the comments-only mode is by setting proper user permissions.

If you need to enable or disable this mode based on some other logic (different from the user permissions), you can set it using the CommentsOnly API.

You can use the following editor configuration:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        commentsOnly: true,
        // More editor's configuration.
        // ...
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

You can also change the mode by setting the CommentsOnly#isEnabled property:

editor.plugins.get( 'CommentsOnly' ).isEnabled = true;

Complementary to this guide, we provide a ready-to-use sample available for download. You may use the sample as an example or as a starting point for your own integration.

# Demo

Check out the comments-only mode in action in the editor below. Please note how only the content-editing features become disabled in this mode. Other features that do not affect the content like export to Word or search (but not replace!) are still available.

# Security

Please remember that your application should be secured both on the frontend and backend. Even though the users will not be able to introduce their changes through the editor, you should still take care of preventing such action in your backend code.