Page History
Excerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1. Initialization OptionsThere are several selectionoptions letting you initialize WProofreader functionality in your web app, namely using:
The WEBSPELLCHECKER_CONFIG (further CONFIG) can be added in a script or loaded from the file as mentioned in Get Started with WProofreader Server (autoSearch) guide for Server version and Get Started with WProofreader Cloud autoSearch. After you have initialized WProofreader, you can customize the above-mentioned settings using WebSpellChecker API.
Below you can find the samples showing how different WProofreader initialization approaches work depending on the integration and expected launch behavior. 1.1. Initializing using autoSearchThe autoSearch feature enables detecting new editable fields on the page and proofreading the text they contain automatically on focus. If you choose this option, WProofreader is enabled in the selected WYSIWYG editor or HTML editable control, and no additional actions are required.
Initialization using inline attributes is suitable and useful if you want to have a single script with basic options definitions. Example 1: Initializing WProofreader with autoSearch using CONFIGThis is an example of the WProofreader initialization with the autoSearch functionality turned on. All the configuration options are defined using WEBSPELLCHECKER_CONFIG.
Example 2: Initializing WProofreader with autoSearch using inline data attributesThis is an example of the WProofreader initialization with the autoSearch functionality turned on. All the configuration options are defined using inline data attributes. In this case, the naming of the options are formed as follows: data-wsc-option_name=”value”. For details, refer to the list of available options in WebSpellChecker API documentation.
1.2. Initialization using init() methodThe init() method is a reasonable choice when you clearly know in which control you want to initialize WProofreader. More than that you are aware of your page controls, and additional controls do not appear dynamically.
Example 3: Initializing WProofreader in HTML element using init() methodThis is an example of WProofreader initialization in HTML contenteditable element (div) using init() method. The configuration options are specified directly in the init() function.
Example 4: Initializating WProofreader in multiple HTML elements using init() methodThis is an example of WProofreader initialization in HTML contenteditable element (div) and HTML editable element (textarea) using init() method. The configuration options for both controls are defined separately in a single CONFIG.
Example 5: Initializing WProofreader in HTML elements using data-wsc-autocreateThis is an example of WProofreader initialization in HTML contenteditable element (div) and HTML editable element (textarea) using data-wsc-autocreate="true". The configuration options are to be defined separately in WEBSPELLCHECKER_CONFIG. This approach is similar to initializing WProofreader using init() method.
Example 6: Initializing WProofreader in WYSIWYG editors using init() methodThere is an option to explicitly initialize WProofreader in such rich text editors as Froala Editor 3, CKEditor 4, and CKEditor 5 using init() method. However, it is strongly recommended to use this method with autoSearch and autoDestroy options in WEBSPELLCHECKER_CONFIG. Turned on/enabled autoDestroy parameter will be monitoring the state of the WEBSPELLCHECKER instance and handling its destroy after removal (deleted or hidden) of an editable container from the page. At the same time enabled autoSearch parameter will restore an instance when it is needed. It can be useful for example, when switching to the code editing mode in the editor, WEBSPELLCHECKER instance must be deleted and then restored after returning back to the editor. Thus, it is the autoSearch that restores it.
|