Ctrlk
DemosChangelog
For the complete documentation index, see llms.txt. This page is also available as Markdown.

JavaScript frameworks

WProofreader is written in pure JavaScript and doesn't require framework-specific setup. You don't need to import, build, or bundle it as a component. It auto-detects editable fields on the page and initializes itself automatically.

This applies to Angular, React, Vue.js, and any other JavaScript framework.

Script-based integration

  1. Find the main HTML file served when someone visits your app:

    • Angular (Angular CLI): src/index.html

    • React (Create React App): public/index.html

    • Vue (Vue CLI): public/index.html

  2. Add the WProofreader configuration and wscbundle.js script inside the <body> tag, ideally right before the closing </body> tag.

For setup details, refer to the Initialization options guide.

NPM integration

Alternatively, you can use the WProofreader SDK npm package. It provides the same functionality as the script-based approach but fits better into a framework build pipeline. After calling any method from the package, it downloads the bundle and makes window.WEBSPELLCHECKER available.

For installation and configuration, refer to the Initialize using npm SDK guide. The GitHub repository includes working examples with CKEditor 4, TinyMCE, Froala, and Quill in Angular, React, and Vue.

PreviousLatency and execution speed “debounce mechanism”NextRich text editors

Last updated

Was this helpful?