# @grammarly/editor-sdk

> Grammarly's writing SDK for web editors

Latest version **2.5.5** (published 2023-10-20) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @grammarly/editor-sdk
pnpm add @grammarly/editor-sdk
yarn add @grammarly/editor-sdk
bun add @grammarly/editor-sdk
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.5.5 |
| Published | 2023-10-20 |
| First published | 2021-04-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 94.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | bgschiller, grammarly-npm-admin, grammarly-npm-ci, gr_artifactory, it_grammarly, michael.chernetsov, rahul.kadyan, dhirtle |
| Keywords | grammarly, grammar, ai, artificial-intelligence, spellcheck, spell-check, spelling, proofreading, english, writing, readability, generative, api, sdk, plugin |

## Links

- npm: https://www.npmjs.com/package/@grammarly/editor-sdk
- Repository: https://github.com/grammarly/grammarly-for-developers
- Homepage: https://developer.grammarly.com/docs
- Issues: https://github.com/grammarly/grammarly-for-developers/issues
- npm.io page: https://npm.io/package/@grammarly/editor-sdk

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 2.5.5 (latest) — 2023-10-20
- 3.0.0-alpha.0 (version3.0.x) — 2023-04-18
- 1.11.0 (version1.11.x) — 2022-09-08
- 1.10.4 (version1.10.x) — 2022-09-07
- 2.0.0-alpha.2 (version2.0.x) — 2022-09-02
- 1.5.2 (version1.5.x) — 2022-03-04
- 2.5.4 — 2023-10-09
- 2.5.3 — 2023-09-25
- 2.5.2 — 2023-09-18
- 2.5.1 — 2023-06-06
- 2.5.0 — 2023-05-31
- 2.4.0 — 2023-05-17
- 2.3.18 — 2023-05-03
- 2.3.17 — 2023-04-18
- 2.3.16 — 2023-04-12
- … 105 more at https://npm.io/package/@grammarly/editor-sdk/versions

## README

# 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).

---
_Source: https://npm.io/package/@grammarly/editor-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._