Spell Checker Pro Plugin

Spell Checker Pro adds spell check as-you-type capabilities to TinyMCE.

The following languages are supported:

• English (US & UK)
• English - with additional medical terms (US & UK)
• Danish
• Dutch
• Finnish
• French
• German
• Italian
• Norwegian
• Portuguese (Brazilian and European)
• Spanish
• Swedish

Cloud Installation

To enable the TinyMCE Enterprise Spellchecking plugin with TinyMCE Cloud:

1. If you are currently using the 'spellchecker' plugin provided with TinyMCE, disable it by removing it from the 'plugins' list.
2. Add 'tinymcespellchecker' to the 'plugins' list.

With TinyMCE Cloud the server-side spellchecking component is automatically configured, so the spellchecker_rpc_url parameter does not need to be set.

Example TinyMCE Configuration

tinymce.init({
    selector: 'textarea',
    plugins: 'tinymcespellchecker',
    spellchecker_language: 'en'
});

Self-hosted Installation

To enable the TinyMCE Enterprise Spellchecking plugin:

1. If you are currently using the 'spellchecker' plugin provided with TinyMCE, disable it by removing it from the 'plugins' list.
2. Add 'tinymcespellchecker' to the 'plugins' list.

For information on installing the server-side component for spell checking, please see the server-side component installation guide.

Example TinyMCE Configuration

tinymce.init({
    selector: 'textarea',
    plugins: 'tinymcespellchecker',
    spellchecker_rpc_url: 'localhost/ephox-spelling',
    spellchecker_language: 'en'
});

Usage

The TinyMCE Enterprise Spellchecking plugin activates automatically when users type content into the editor. To see and select a spelling suggestion after a word has been misspelled, please right click the misspelled red underlined word.

Configuration Options

spellchecker_rpc_url

This setting enables you to specify the URL to be used for the server side ephox-spelling service. Check the server-side component installation guide for details on how to setup your own spellchecker server.

Note: spellchecker_rpc_url is not required when enabling this plugin via TinyMCE Cloud

spellchecker_languages

This optional setting allows you to specify the languages that are available to the user, provided as a comma delimited string. The default value for this setting is:

'US English=en,UK English=en_gb,Danish=da,Dutch=nl,Finnish=fi,French=fr,German=de,Italian=it,Norwegian=nb,Brazilian Portuguese=pt_BR,Iberian Portuguese=pt_PT,Spanish=es,Swedish=sv'

spellchecker_language

This optional setting allows you to specify the language code that will be used by default. This defaults to "en".

The following languages are supported:

spellchecker_dialog

This optional setting allows you to specify the mode of operation of the spellchecker. When set to true, the spellchecker will open a dialog that will check all of the document's contents at once. This also allows a user to step through each error, to ignore errors and accept recommended fixes. If the spellchecker dialog is enabled, the default as-you-type spellchecking will be disabled.

spellchecker_whitelist

This option lets you specify an array of words that you want to ignore this can for example be the current company name or internal products. You can populate this field from a file by just getting the white list array from an external JS file.

spellchecker_on_load

This option lets run the spellchecker when the contents is loaded into the editor. This option defaults to "false" so it's disabled by default.

spellchecker_active

This option lets you decide if the spellchecker should be initialized as active or not. With this set to false the spellchecker will not be activated automatically on text input, you will have to press the toolbar button or the menu item to start the spellchecking. Only applicable when using the default as-you-type spellchecking, not while using the dialog mode. Defaults to true.

Toolbar Buttons

spellchecker

This button allows the user to perform a spellcheck on the entire document. In addition, the drop down menu attached to this button allows you to specify the language that is currently used when spellchecking. You'll find more information about customizing the toolbar in the Editor Appearance section of the documentation.

Example TinyMCE Configuration:

tinymce.init({
  selector: 'textarea',
  plugins: 'tinymcespellchecker',
  toolbar: 'spellchecker',
  spellchecker_rpc_url: 'localhost/ephox-spelling',
  spellchecker_language: 'en'
});

Menu items

spellchecker

This menu item allows the user to perform a spell check on the entire document.

spellcheckerlanguage

This menu item allows you to change the current language for the spell checking process.

Example TinyMCE Configuration:

tinymce.init({
  selector: 'textarea',
  plugins: 'tinymcespellchecker',
  menu: {
    tools: {title: 'Tools', items: 'spellchecker spellcheckerlanguage'}
  },
  spellchecker_rpc_url: 'localhost/ephox-spelling',
  spellchecker_language: 'en'
});

Events

SpellCheckerIgnore event

This event gets fired when the user selects ignore word on a misspelled word.

Here is an example of using the event:

tinymce.init({
  selector: 'textarea',
  plugins: 'tinymcespellchecker',
  toolbar: 'spellchecker',
  init_instance_callback: function (editor) {
    editor.on('SpellCheckerIgnore', function (e) {
      console.log('Ignore word', e.word);
    });
  }
});

SpellCheckerIgnoreAll event

This event gets fired when the user selects ignore word on a misspelled word.

Here is an example of using the event:

tinymce.init({
  selector: 'textarea',
  plugins: 'tinymcespellchecker',
  toolbar: 'spellchecker',
  init_instance_callback: function (editor) {
    editor.on('SpellCheckerIgnoreAll', function (e) {
      console.log('Ignore word (all)', e.word);
    });
  }
});

Downloading Spell Checker Pro

A TinyMCE Enterprise subscription includes the ability to download and install a spell check as-you-type feature for the editor.

Spell Checker Pro requires both a client-side plugin to be configured and a server-side component to be installed and configured.

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.