Getting started with WProofreader plugin for CKEditor 5

WProofreader plugin for CKEditor 5 inherits all functionality of the WProofreader component with slight adaptation to the view and features of the editor. Right now the plugin is just a “wrapper” for the classic WProofreader. Thus, WProofreader will be more native to CKEditor 5 build procedure. 

The main differences between the plugin and classic WProofreader are:

• part of build and configuration of CKEditor 5;
• tailored color theme for CKEditor 5 based on previously discussed styles;
• automatically disabled Dialog mode in case of real-time collaboration features and multi-root plugin;
• better work of WProofreader as you type mode in case of multi-root plugin (languages and settings synchronization between instances).

For more details, please refer to the official repo or NPM package of the WProofreader plugin for CKEditor 5.

If your preference is to use the plugin instead of the classic WProofreader initialization, please follow the steps below.

1. Clone CKEditor 5 Classic editor:

git clone -b stable [email protected]:ckeditor/ckeditor5-build-classic.git

2. Go to the editor folder:

cd ckeditor5-build-classic

3. Install all the required dependencies:

cd ckeditor5-build-classic

4. Install the WProofreader plugin:

npm install @webspellchecker/wproofreader-ckeditor5 --save-dev

5. Open ckeditor5-build-classic/src/ckeditor.js file.

6. Import the WProofreader plugin:

import WProofreader from '@webspellchecker/wproofreader-ckeditor5/src/wproofreader';

7. Add WProofreader plugin to ClassicEditor.builtinPlugins:

ClassicEditor.builtinPlugins = [
    ...,
    WProofreader
];

8. Add the wproofreader field and its options to ClassicEditor.defaultConfig:

ClassicEditor.defaultConfig = {
    ...,
    wproofreader: {
        serviceId: 'your-service-ID',
        srcUrl: 'https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js'
    }
}

9. Rebuild the bundle:

npm run build

That's it. Now you should be able to use the spelling and grammar checking functionality of WProofreader with CKEditor 5. Try it out on the default sample page: ckeditor5-build-classic/sample/index.html.