You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This guide outlines the main steps that you need to follow in order to integrate and configure WebSpellChecker Proofreader with CKEditor 5. All the described steps are provided for the Cloud version of WebSpellChecker Proofreader.

Initialize CKEditor 5

Before integrating and configuring WebSpellChecker Proofreader, CKEditor should be properly configured in your web application. If you haven't done it yet, please refer to Quick Start on the CKEditor 5 documentation pages.

Grant WebSpellChecker Proofreader Access to CKEditor 5 Instance

Adjust initialization of CKEditor 5 to grant WebSpellChecker Proofreader access to it. You need to add a link to CKEditor 5 instance object as shown on the example below.

<textarea name="content" id="editor">This is a sample text.</textarea>
 
<script>
        ClassicEditor
            .create(document.querySelector('#editor'))
            .then(editor => {
                editor.element.querySelector('.ck-editor__editable').editor = editor;
            })
</script> 

Add WebSpellChecker Proofreader Script

Add the wscbundle.js script on your web page.

<script type="text/javascript" src="https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js"></script>

Initialize WebSpellChecker Proofreader with 'autoSearch' 

Define the required configuration options in WEBSPELLCHECKER_CONFIG.

  • The configuration options can be added as a script directly on the page or loaded from *.js file (e.g. wscbundle_config.js) where you define these options.
  • It can be added to any location on a web page before or after the wscbundle.js script. However, if you add wscbundle.js asynchronously, the configuration options must be loaded before the script.

Required options for the WProofreader Cloud:

  • Specify your serviceId. It is a required option for the service activation.
  • Enable autoSearch functionality using the autoSearch parameter.

This is an example of the defining WEBSPELLCHECKER_CONFIG in a separate script directly on a web page.

<script>
	window.WEBSPELLCHECKER_CONFIG = {
		autoSearch: true,
		lang: 'auto', // set the default language
        serviceId: 'your-service-ID' // the activation key for the Cloud-based version
   };
</script>

Alternatively, you can create a *.js file (e.g. wscbundle_config.js) with WEBSPELLCHECKER_CONFIG on your end and then load it from the file on your web page as shown in example below.

This is an example of the wscbundle_config.js file with WEBSPELLCHECKER_CONFIG.

wscbundle_config.js
window.WEBSPELLCHECKER_CONFIG = {
	autoSearch: true,
	lang: 'en_US',
    serviceId: 'your-service-ID'
};

Here is an example of the script that you need to add on your web page with the path to wscbundle_config.js.

<script type="text/javascript" src="[path_to_config]/wscbundle_config.js"></script>