Spell Checker Pro plugin
This plugin is only available for paid TinyMCE subscriptions. |
Spell Checker Pro adds spell checking as-you-type capabilities to TinyMCE. For information on the supported languages, refer to this section.
-
TinyMCE
-
HTML
-
JS
-
Edit on CodePen
<textarea id="spellcheckerpro">
<h1><span lang="en">The Hare and the Tortoise</span></h1>
<p><span lang="en">A HARE one day riddiculed the short feet and slow pace of the Tortoise, who replied, laughing: “Though you be swift as the wind, I will beeat you in a race.” The Hare, beleiving her assertion to be simply impossable, assented to the proposal; and they agreed that the Fox should choose the course and fix the gaol. On the day appointed for the race the two started together. The Tortoise never for a momment stopped, but went on with a slow but steady pace straight to the end of the corse. The Hare, lying down by the wayside, fell fast asleep. At last waking up, and moving as fast as he could, he saw the Tortoise had reached the goal, and was comfortably dozzing after her fatigue.</span></p>
<p><span lang="en">Slow but steady wins the race.</span></p>
<h1><span lang="es">La liebre y la tortuga</span></h1>
<p><span lang="es">Un día, una liebre ridiculizó los pies cortos y el ritmo lento de la tortuga, quien respondió riendo: "Aunque seas veloz como el viento, te venceré en una carrera". La Liebre, creyendo que su afirmación era simplemente imposible, asintió a la propuesta; y acordaron que Fox debería elegir el curso y fijar el objetivo. El día designado para la carrera, los dos comenzaron juntos. La Tortuga nunca se detuvo por un momento, sino que continuó con un ritmo lento pero constante hasta el final del curso. La Liebre, acostada en el camino, se quedó profundamente dormida. Al despertarse y moverse lo más rápido que pudo, vio que la Tortuga había alcanzado la meta y dormitaba cómodamente después de su fatiga.</span></p>
<p><span lang="es">Lento pero constante gana la carrera.</span></p>
<h1><span lang="de">Der Hase und die Schildkröte</span></h1>
<p><span lang="de">Eines Tages hat ein Hase die kurzen Füße und das langsame Tempo der Schildkröte beseitigt, die lachend antwortete: "Obwohl du so schnell wie der Wind bist, werde ich dich in einem Rennen schlagen." Der Hase, der glaubte, ihre Behauptung sei einfach unmöglich, stimmte dem Vorschlag zu; und sie waren sich einig, dass der Fuchs den Kurs wählen und das Gefängnis reparieren sollte. An dem für das Rennen festgelegten Tag starteten die beiden zusammen. Die Schildkröte hörte nie für einen Moment auf, sondern ging mit einem langsamen, aber stetigen Tempo direkt bis zum Ende der Leiche weiter. Der Hase, der auf der Strecke lag, schlief fest ein. Als er endlich aufwachte und sich so schnell er konnte bewegte, sah er, dass die Schildkröte das Ziel erreicht hatte und nach ihrer Müdigkeit bequem döste.</span></p>
<p><span lang="de">Langsam aber stetig gewinnt das Rennen.</span></p>
<p> </p>
<p><strong>Based on:</strong> Aesop, 'Aesop’s Fables: The Hare and the Tortoise', <a href="https://www.gutenberg.org/files/21/21-h/21-h.htm#link2H_4_0018" target="_blank" rel="noopener">https://www.gutenberg.org/files/21/21-h/21-h.htm#link2H_4_0018</a></p>
<p><em>Translations provided by <a href="https://translate.google.com/">Google Translate</a>.</em></p>
</textarea>
tinymce.init({
selector: 'textarea#spellcheckerpro',
plugins: 'code tinymcespellchecker link',
toolbar: 'spellchecker language spellcheckdialog',
height: 500,
spellchecker_language: 'en',
content_langs: [
{ title: 'English (US)', code: 'en_US' },
{ title: 'English (US Medical)', code: 'en_US', customCode: 'en_US-medical' },
{ title: 'English (UK)', code: 'en_UK' },
{ title: 'English (UK Medical)', code: 'en_UK', customCode: 'en_UK-medical' },
{ title: 'Spanish', code: 'es' },
{ title: 'French', code: 'fr' },
{ title: 'German', code: 'de' },
{ title: 'Portuguese', code: 'pt' },
{ title: 'Chinese', code: 'zh' }
],
content_style: 'body { font-family:Helvetica,Arial,sans-serif; font-size:14px }'
});
Cloud Installation
To enable the TinyMCE Enterprise Spellchecking plugin with Tiny Cloud:
-
If configured, disable the
spellchecker
plugin provided with TinyMCE, by removing it from theplugins
list. -
Add
tinymcespellchecker
to theplugins
list.
With Tiny Cloud the server-side spellchecking component is automatically configured, so the spellchecker_rpc_url
parameter does not need to be set.
Self-hosted Installation
To enable the TinyMCE Enterprise Spellchecking plugin:
-
If configured, disable the
spellchecker
plugin provided with TinyMCE, by removing it from theplugins
list. -
Add
tinymcespellchecker
to theplugins
list.
For information on installing the server-side component for spell checking, please see the server-side component installation guide.
Usage
The TinyMCE Enterprise Spellchecking plugin activates automatically when users type content into the editor. To select a spelling suggestion for a misspelled word, right-click the misspelled word to open the contextual menu.
Configuration Options
spellchecker_active
This option enables or disables the spell checker when the editor is loaded. When set to false
, the spellchecker will not be active when the editor is initialized. The toolbar button or the menu item will have to be selected by the user to start the spell checker.
Type: Boolean
Default Value: true
Possible Values: true
, false
spellchecker_dialog
This option specifies the primary spell checking mode.
-
When set to
true
, thespellcheck
toolbar button will open a dialog that will step the user through each potential spelling error in the document. -
When set to
false
, thespellcheck
toolbar button will enable or disable as-you-type spell checking and thespellcheckdialog
toolbar button will open the spell checker dialog.
Type: Boolean
Default Value: false
Possible Values: true
, false
spellchecker_language
This option specifies the default language used by Spell Checker Pro.
Type: String
Default Value: 'en_US'
Example: Using spellchecker_language
tinymce.init({
selector: 'textarea',
plugins: 'tinymcespellchecker',
spellchecker_language: 'de'
});
Supported languages
The following languages are supported for the Spell Checker Pro plugin. All of the listed languages are supported for customers using TinyMCE version 5.9 or higher on Tiny Cloud.
Language |
Code |
Pre-packaged with |
Supported Hunspell dictionaries |
Afrikaans (South Africa) |
af_ZA |
✖ |
✔ |
English (Australia) |
en_AU |
✖ |
✔ |
English (Canada) |
en_CA |
✖ |
✔ |
English (United Kingdom) |
en_GB, en_UK, en_BR |
✔ |
✔ |
English (United States) |
en, en_US |
✔ |
✔ |
Medical English (US) |
en_US-medical |
✔ |
✔ |
Medical English (UK) |
en_GB-medical |
✔ |
✖ |
Danish |
da |
✔ |
✔ |
Dutch |
nl |
✔ |
✔ |
Finnish |
fi |
✔ |
✖ |
French |
fr |
✔ |
✔ |
German |
de |
✔ |
✔ |
Hungarian |
hu |
✖ |
✔ |
Italian |
it |
✔ |
✔ |
Maori (New Zealand) |
mi_NZ |
✖ |
✔ |
Norwegian Bokmål |
nb |
✔ |
✔ |
Norwegian Nynorsk |
nn |
✖ |
✔ |
Polish |
pl |
✖ |
✔ |
Portuguese (Brazil) |
pt |
✔ |
✔ |
Portuguese (Portugal) |
pt_PT |
✔ |
✔ |
Spanish |
es |
✔ |
✔ |
Swedish |
sv |
✔ |
✔ |
Swedish (Finland) |
sv_FI |
✖ |
✔ |
spellchecker_languages
This option specifies the spellchecker languages that are available to the user, provided as a comma delimited string. For a list of available languages, see: Supported languages.
Type: comma-separated String
Default Value:
'English (United States)=en_US,English (United Kingdom)=en_GB,Danish=da,Dutch=nl,Finnish=fi,French=fr,German=de,Italian=it,Norwegian=nb,Portuguese=pt,Portuguese (Portugal)=pt_PT,Spanish=es,Swedish=sv'
Example: Using spellchecker_languages
tinymce.init({
selector: 'textarea',
plugins: 'tinymcespellchecker',
spellchecker_languages: 'US English=en_US,UK English=en_GB,Danish=da,Dutch=nl,Finnish=fi,French=fr,German=de,Italian=it,Norwegian=nb,Brazilian Portuguese=pt,Iberian Portuguese=pt_PT,Spanish=es,Swedish=sv'
});
spellchecker_on_load
Removed in Spell Checker Pro 2.0 (TinyMCE 5.2). Spell Checker Pro will now always run on editor initialization. To disable Spell Checker Pro on load, use spellchecker_active .
|
This option runs the spellchecker when the contents of the editor is loaded.
Type: Boolean
Default Value: false
Possible Values: true
, false
spellchecker_rpc_url
This option specifies the URL of the server-side ephox-spelling
service. For instructions on how to set up a Spell Checker Pro server-side component, see: the server-side component installation guide.
spellchecker_rpc_url is not required when enabling this plugin via Tiny Cloud
|
Type: String
content_langs
This feature is only available for TinyMCE 5.9 and later.
The content_langs option replaces the spellchecker_select_languages option. The value of the spellchecker_select_languages option, or its default, are used as a fallback for content_langs .
|
This option sets the languages displayed in the language
toolbar button and the language
menu item. The option accepts an array of language specs. Each language spec is a JavaScript object defined using the following properties.
Name | Type | Requirement | Description |
---|---|---|---|
|
String |
required |
The name shown for this language in the UI. |
|
String |
required |
The language tag, as defined in Tags for Identifying Languages (BCP47), for this language. This language tag is placed in the |
|
String |
optional |
An alternative language tag, that does not need to be compatible with BCP47. This string is placed in the |
Type: Array
Example: Using content_langs
to change spelling dictionaries
The Spell Checker Pro plugin will use the code
property to determine which dictionary to use on the content, unless the customCode
property is available. The language tag specified by customCode
overrides the spelling dictionary, to allow for non-standard languages such as the medical dictionaries provided with Spell Checker Pro. For all languages, ensure that:
-
The
code
property is valid language tag, according to Tags for Identifying Languages (BCP47) -
Either the
code
property is one of the Supported Languages or thecustomCode
override property is defined. -
The
customCode
property is one of the Supported Languages if it is defined.
For example:
tinymce.init({
selector: 'textarea', // change this according to your HTML
toolbar: 'language',
plugins: 'tinymcespellchecker',
content_langs: [
{ title: 'English (US)', code: 'en_US' },
{ title: 'English (US Medical)', code: 'en_US', customCode: 'en_US-medical' },
{ title: 'English (UK)', code: 'en_UK' },
{ title: 'English (UK Medical)', code: 'en_UK', customCode: 'en_UK-medical' },
{ title: 'Spanish', code: 'es' },
{ title: 'French', code: 'fr' },
{ title: 'German', code: 'de' },
{ title: 'Portuguese', code: 'pt' },
{ title: 'Chinese', code: 'zh' }
]
});
spellchecker_select_languages
This option will be removed in TinyMCE 6.0. |
The spellchecker_select_languages option was deprecated with the release of TinyMCE 5.9. The content_langs option should be used instead. This change was made to allow more control over the way languages are specified, and to reflect that the option can be used outside of spell checking.
|
This option specifies the languages that can be set for content when working with multi-language content. The specified languages will be available from the language
toolbar drop-down menu button. For a list of available languages, see: Supported languages.
Type: comma-separated String
Default Value: 'en,es,fr,de,pt,zh'
spellchecker_ignore_list
This option specifies which words should be ignored by the spell checker. If an array of words is provided, the specified words will be ignored for all languages. If an object containing an array of words per language is provided, the specified words will be ignored for the specified languages.
Languages specified as keys in the spellchecker_ignore_list object must match the configured Spellchecker Languages.
|
Type: String[]
or Object