Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
@webspellchecker/wproofreader-sdk-js
Advanced tools
Changelog
1.0.1 – 2023-09-25
Internal changes (updated dependencies, documentation, etc.).
Readme
WProofreader SDK empowers your web applications with real-time multilingual spelling, grammar, and style checks. The SDK integrates seamlessly with rich text editors and text fields across various platforms, including those developed using popular JavaScript frameworks like Angular, React, and Vue.js. It offers users instant correction suggestions as they type or within a dedicated dialog.
Visit the WProofreader SDK repository or the official web page for more detailed information.
Find below the instructions that will guide you in easily integrating this functionality into your applications.
To add WProofreader SDK to your project, install the npm module using the following command.
npm install @webspellchecker/wproofreader-sdk-js
Import WProofreader SDK:
import WProofreaderSDK from '@webspellchecker/wproofreader-sdk-js';
Define global configuration. Regardless of your chosen initialization method, you'll need to configure the SDK globally. Use the configure
method to set general options. Detailed descriptions of all available customization options can be found in the documentation.
Please note that the configure
method needs to be called in the file that initializes the application.
WProofreaderSDK.configure({
autoSearch: true,
lang: 'en_US' // Sets the default language. If not specified, auto-defined language will be used.
// Additional options here, e.g. the on-premise endpoint or cloud service activation key
});
Choose the initialization method. After setting general options, proceed to initialize the SDK using one of the methods below.
autoSearch
optionAutomatically enable WProofreader when an editable container gains focus. Add autoSearch: true
to your configure
method if you haven't already.
WProofreaderSDK.configure({
autoSearch: true,
lang: 'en_US'
// Additional options here
});
data-wsc-autocreate
data attributeAdd the data-wsc-autocreate="true"
attribute to your editable container (e.g. textarea) to initialize WProofreader automatically with the page load (no need to set the focus). This must be applied to static elements that are part of the initial HTML markup.
<textarea data-wsc-autocreate="true" type="text">Some text.</textarea>
It’s recommended to use this initialization method in a bundle with the autoSearch
option if the page will be dynamically modified.
init
methodUse init
method to inialize WProofreader in a container. You can specify the other configuration options for the local initialization if needed. Or skip using configure
method all together and set all the options directly in the init
method.
WProofreaderSDK.init({
container: document.getElementById('container')
// Additional options here
});
It’s recommended to use this initialization method in a bundle with the autoSearch
option if the page will be dynamically modified.
Version-specific configuration. Depending on whether you are using WProofreader as the cloud service or opt for on-premise deployment, further configuration is necessary.
Add serviceId
option with your activation key that you received during registration. It’s a mandatory option for activating and using the service.
WProofreaderSDK.configure({
// Main options here
serviceId: 'your-service-ID'// required for the Cloud version only
});
Specify the backend endpoint hosted on your infrastructure using corresponding options as shown below. This version does not require the serviceId
option.
WProofreaderSDK.configure({
// Main options here
serviceProtocol: 'https',
serviceHost: 'localhost',
servicePort: '443',
servicePath: 'virtual_directory/api', // by default the virtual_directory is wscservice
srcUrl: 'https://host_name/virtual_directory/wscbundle/wscbundle.js'
});
For technical support or inquiries, reach out to us directly if you hold an active subscription or commercial license. Contact us here.
To report bugs or issues, please use the GitHub Issues section of the WProofreader SDK repository. When reporting an issue, kindly provide steps to reproduce it, and mention the browser and integration where the issue occurred.
The source code in this repository is licensed under the Apache 2.0 license. Please note that while the code is open-source, the usage of the WProofreader service is governed by separate terms. Refer to the LICENSE.md for detailed licensing information and related links.
FAQs
WProofreader SDK package to simplify the integration into modern JavaScript applications.
We found that @webspellchecker/wproofreader-sdk-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).