Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide section outlines the main steps that you need to follow in order to integrate and configure the SCAYT plugin for CKEditor for CKEditor 4.0+. All the described steps are provided  All steps described in this section are applicable for the Cloud version of SCAYT plugin for CKEditor 4.

Tip

Good to know:

  • The SCAYT plugin is an integrated spell spelling and grammar checking solution in the standard package for CKEditor 4.0+. By default  By default, the SCAYT plugin for CKEditor is pointed to the Free WebSpellChecker Cloud Services. The  The free version is provided with some usage limitations and banner ads.with the banner ad and limited functionality is available for free for all CKEditor customers. 
  • The paid services allows the allow customers to get rid of the banner ad, lift the usage limitations and get the extra functionality and languages. 
  • To get started with the paid version of SCAYT for CKEditor 4.0+, it is required to subscribe to the SCAYT Cloud SCAYT services. On the subscription, you will receive an email with your encrypted customer service ID, an activation key, that is required for the SCAYT service activation.

1.

...

 Initialize CKEditor 4

Before integrating and configuring the SCAYT plugin, Froala Editor CKEditor 4 should be properly configured in your web application. If you haven't done it yet, please refer to the Froala Editor's Get Started instructions on the Froala Editor official website. 

2. Adding SCAYT Script and Styles

As soon as Froala Editor is properly set on you page, feel free to jump to this step. You need to add a script for the SCAYT plugin and define its styles as follows.

...

download the latest version of the CKEditor 4 standard package and refer to CKEditor Quick Start Guide.

2. Obtain SCAYT activation key

Prior to SCAYT integration, you are required to subscribe to trial version of SCAYT CloudOn the subscription, you will receive a confirmation email with your subscription information and service ID, an activation key. It is required for the service activation and further use. 

You can also find your service ID on your account page on the webspellchecker.com website. 

Info

If you already have an active subscription, skip this step and jump to the next one.

3. Activate SCAYT plugin

If you are using the standard package of CKEditor 4, the SCAYT plugin is already there, which is pointed to the Free services. To accomplish migration to the trial or paid version of SCAYT Cloud, the scayt_customerid parameter with the service ID, an activation key, must be added to CKEditor config.js file

...

.

Code Block
languagejs
themeEmacs
<script src='https://cdnjs.cloudflare.com/ajax/libs/froala-editor/2.7.6/js/third_party/spell_checker.min.js'></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/froala-editor/2.7.6/css/third_party/spell_checker.min.css" type="text/css" />

3. Creating Froala Editor Instance with Default SCAYT Options

...

config.scayt_customerId = 'your-service-id';

4. Adjust default settings

There is a list of parameters available that you can use to adjust the default behavior of SCAYT. For example, start SCAYT spelling and grammar automatically, change default language, etc. For details, refer to the SCAYT parameters for CKEditor guide. 

Code Block
languagejs
themeEmacs
$('#editor1').froalaEditor({
    scaytAutoload: true,
    scaytCustomerId: 'encryped_customer_ID',
    pluginsEnabled: ['spellChecker'],
    toolbarButtons: ['bold', 'italic', 'spellChecker', '|', 'undo', 'redo'],
    toolbarButtonsMD: null,
    toolbarButtonsSM: null,
    toolbarButtonsXS: null,
    scaytOptions: {
        enableOnTouchDevices: false,
        enableGrayt: true;
        localization:'en',
        extraModules: 'ui',
        spellcheckLang: 'en_US',
        contextMenuSections: 'suggest|moresuggest',
        contextMenuForMisspelledOnly: true
    }
});

4. Configuring SCAYT

You have also an option to define additional SCAYT parameters and change the default values (e.g. change default spell checking language, etc.).

...

titleClick here to see a full list of SCAYT API parameters and possible values...
config.scayt_autoStartup = true;
config.grayt_autoStartup = true;
config.scayt_sLang ="en_US";


Info

Check a demo page with SCAYT plugin for CKEditor on our website.


...

Still need help

...

?

If you are still experience some difficulties with configuring SCAYT plugin for CKEditor, please check our the training video on our official YouTube channel. It  It will guide you through all configurations steps and demonstrate how to enable a comprehensive spell and grammar checking tool in CKEditor.

Widget Connector
width560
urlhttps://www.youtube.com/watch?v=D0ahmVjYBq8&t=1s
height315


...

Can be also useful: