Spell Checker plugin
Enables TinyMCE's spellcheck functionality.
Contribute to this pageImportant: The free TinyMCE Spell Checker plugin (
spellchecker
) was deprecated with the release of TinyMCE 5.4. For details, see the free TinyMCE Spell Checker plugin deprecation notice. The free Spell Checker plugin will be removed in TinyMCE 6.0.
Note: The Spell Checker plugin is self-hosted only. The Spell Checker Pro plugin is provided for some Tiny Cloud plans. For information on the Spell Checker Pro plugin, see: Spell Checker Pro plugin.
This plugin enables TinyMCE’s spellcheck functionality. It also adds a toolbar button and the menu item Spellcheck
under the Tools
menu dropdown.
Basic setup
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_rpc_url: 'spellchecker.php'
});
Options
These settings affect the execution of the spellchecker
plugin by modifying how spellchecking is handled. If you need an introduction to setting up server-side spell checking with TinyMCE please refer to this section in the General Configuration Guide.
spellchecker_callback
This option lets you override the default server side request/communication logic for the spellchecker.
Example of a basic override without using a server
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_callback: function (method, text, success, failure) {
var words = text.match(this.getWordCharPattern());
if (method === "spellcheck") {
var suggestions = {};
for (var i = 0; i < words.length; i++) {
suggestions[words[i]] = ["First", "Second"];
}
success({ words: suggestions, dictionary: [ ] });
} else if (method === "addToDictionary") {
// Add word to dictionary here
success();
}
}
});
Example of fallback for the older JSON-RPC based format
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_callback: function (method, text, success, failure) {
if (method === 'spellcheck') {
tinymce.util.JSONRequest.sendRPC({
url: '/tinymce/spellchecker.php',
method: 'spellcheck',
params: {
lang: this.getLanguage(),
words: text.match(this.getWordCharPattern())
},
success: function (result) {
success(result);
},
error: function (error, xhr) {
failure("Spellcheck error:" + xhr.status);
}
});
} else {
failure('Unsupported spellcheck method');
}
}
});
spellchecker_language
This configuration option lets you set the default language code for the spellchecker. This defaults to “en”.
Type: String
Default Value: en
Example: Using spellchecker_language
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_language: 'sv_SE'
});
spellchecker_languages
This option lets you specify a list of languages for the user to select from. The list is added to the spellcheck toolbar icon. The format is based on the 3.x spellchecker
format.
Type: String
Default Value:
'English=en,Danish=da,Dutch=nl,Finnish=fi,French=fr_FR,' +
'German=de,Italian=it,Polish=pl,Portuguese=pt_BR,Spanish=es,Swedish=sv'
Example: Using spellchecker_languages
tinymce.init({
selector: 'textarea', // change this value according to your html
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_languages: 'English=en,Danish=da,Dutch=nl,Finnish=fi,French=fr_FR,' +
'German=de,Italian=it,Polish=pl,Portuguese=pt_BR,Spanish=es,Swedish=sv'
});
spellchecker_rpc_url
This options enables you to specify a custom URL to be used for the spellchecker. This can be the spellchecker
URL provided by the TinyMCE spellchecker
packages or a URL to a page that you have in your system. The URL is relative to the spellchecker
plugin.
Type: String
Example: Using spellchecker_rpc_url
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_rpc_url: 'spellchecker.php'
});
Spellchecker request format
The request is a HTTP POST with URL encoded parameters described below.
Parameter | Description |
---|---|
method | Default to “spellcheck” might be other things in the future for storing custom dictionaries etc. |
text | Text to spellcheck this will contain a plain text version of the current editor contents. |
lang | The currently selected language code for example “en” or “sv_SE”. |
Spellchecker response format
The response of a successful spellcheck request should like this:
{
"words": {
"misspelled1": ["suggestion1", "suggestion2"],
"misspelled2": ["suggestion1", "suggestion2"]
}
}
And if there was an error:
{
"error": "Error message"
}
spellchecker_wordchar_pattern
This option enables you to override the matching of characters that are parts of words. By default it will treat anything that isn’t a space, comma, dot, dash, quote, etc, as parts of a word. For some languages or environments it might be useful to override this behavior.
Type: String
Example: Using spellchecker_wordchar_pattern
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: 'spellchecker',
menubar: 'tools',
toolbar: 'spellchecker',
spellchecker_wordchar_pattern: /[^\s,\.]+/g
});
Toolbar buttons
The Spell Checker plugin provides the following toolbar buttons:
Toolbar button identifier | Description |
---|---|
spellchecker | Spellchecks the current editor contents. |
These toolbar buttons can be added to the editor using:
- The
toolbar
configuration option. - The
quickbars_insert_toolbar
configuration option. - Custom Context toolbars.
Menu items
The Spell Checker plugin provides the following menu items:
Menu item identifier | Default Menu Location | Description |
---|---|---|
spellchecker | Tools | Toggles the spellchecker on/off. |
These menu items can be added to the editor using:
- The
menu
configuration option. - The
contextmenu
configuration option. - Custom Menu toolbar buttons.
Commands
The Spell Checker plugin provides the following JavaScript command.
Command | Description |
---|---|
mceSpellCheck | Toggles spellchecking on/off. |
Example
tinymce.activeEditor.execCommand('mceSpellCheck');
Was this article helpful? Yes - No
Well, that's awkward . Would you mind opening an issue or helping us out?
Thanks for the feedback!
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.