# Grammarly Text Editor SDK

Add Grammarly's real-time writing support to your app with just a few lines of code.

![A code snippet shows how to add the Grammarly Text Editor Plugin to a textarea. Then an animation of a user accepting a Grammarly suggestion in a chat app appears.](https://github.com/grammarly/grammarly-for-developers/blob/main/docs/sdk_product_animation.gif?raw=true)

This package is designed for vanilla JavaScript apps. Visit [@grammarly/editor-sdk-react](https://www.npmjs.com/package/@grammarly/editor-sdk-react) for our package for React apps and [@grammarly/editor-sdk-vue](https://www.npmjs.com/package/@grammarly/editor-sdk-vue) for our package for Vue apps.

## Getting started

Here's how to get started:

1. Create a new [Grammarly for Developers app](https://developer.grammarly.com/apps?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js)
1. Install the Grammarly Text Editor SDK:

   ```bash
   npm install @grammarly/editor-sdk
   ```

1. Initialize the SDK with your client ID:

   ```ts
   import * as Grammarly from "@grammarly/editor-sdk";

   Grammarly.init("YOUR_CLIENT_ID");
   ```

1. Add the Grammarly Text Editor Plugin to your text editors by wrapping them with the [grammarly-editor-plugin](https://developer.grammarly.com/docs/api/editor-sdk/grammarlyeditorpluginelement?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js) web component.
   ```ts
   <grammarly-editor-plugin>
     <textarea></textarea>
   </grammarly-editor-plugin>
   ```

## Learn more

If you'd like to learn more about what you can do with the SDK and how you can customize the plugin for your app, visit:

- [Grammarly for Developers Documentation](https://developer.grammarly.com/docs/?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js)
- [Grammarly for Developers API Reference](https://developer.grammarly.com/docs/api/editor-sdk/?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js)
- [Grammarly for Developers Code Examples on GitHub](https://github.com/grammarly/grammarly-for-developers)

## Ask a question

If you want to ask a question, share a suggestion, or chat about how you're using the Grammarly Text Editor SDK in your app, join us in the [Grammarly for Developers community on GitHub](https://github.com/grammarly/grammarly-for-developers/discussions).