Grammarly Text Editor SDK for Desktop Clients (Electron)

You can use the Grammarly Text Editor SDK in desktop applications built on Electronopen in new window.

Installation and usage

Installing and using the Text Editor SDK in your Electron application works the same way as it does for a web application. For more details on how to install and use the SDK, visit the reference that matches your application’s tech stack:

• Text Editor SDK for JavaScript
• Text Editor SDK for React
• Text Editor SDK for Vue

Content Security Policy

You may need to adjust your application’s Content Security Policyopen in new window in order for the SDK to work. See the FAQ for more details.

Connected accounts

To allow your users to connect their Grammarly accounts to your application, turn on connected accounts. You will need to configure connected accounts in both the App Console and your application code. See configuring connected accounts for desktop clients (Electron) for details.

API

Visit the API reference for additional configuration details.

Electron compatibility

The Text Editor SDK supports desktop applications built on Electron 12.0.0+.

Examples

Example applications are available in the Grammarly for Developers GitHub repositoryopen in new window:

• Electron Demo App (JavaScript and HTML)open in new window
• Electron Demo App (JavaScript and npm)open in new window
• Electron Demo App (React)open in new window
• Electron Demo App (Vue)open in new window

Preparing for production

Before making your app available in a production environment, please take note of the recommendations in Securing Your Integration.