Introduction
This component was developed in JavaScript using an API call to the LanguageTool service, which is free up to a certain usage limit and offers premium packages based on the number of daily queries. It validates written words and provides correction suggestions when necessary, ensuring improved accuracy and consistency in text input.
The component comes with key features such as:
Getting Started
After downloading the component to your environment, you need to go to the application where you want to use the component and add the 'Spellchecker' web block as a reference (see image below).
API Integration
O11
The component is based on the free version of LanguageTool, but if you have access credentials for the premium version, you can configure this directly in the Site Properties section (as shown in the image below).
Usage Instructions
For each use, you must mandatory provide the Language that should be considered for that field, as well as the inputName (associated field). In case of an edit where there is a previous value that should be displayed, it must be sent in the initialText (optional) field. By default, the input length is 50; if you wish to customize it, simply pass the desired value in the InputLength input
To check the available languages, LanguageTool provides the following endpoint: https://api.languagetoolplus.com/v2/languages.
If you want to disable certain rules from your text validation, you can visit the link to see the available rules and add them to the DisabledRules setting in the app where the SpellChecker is being used. (e.g. WHITESPACE_RULE)
Examples of the Component in Action
Click on the red highlight to see the correction suggestions.
If you want to block a word (e.g., ugly) from the field, you can add it to the setting called BlockedWords, and the result can be checked below.
The result can be seen in the image below.
The documentation can be found here