Notorious Penguin Magicians

    @grammarly/editor-sdk-react
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.0 • Public • Published

    Grammarly Text Editor SDK for React

    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.

    This package is designed for React apps. Visit @grammarly/editor-sdk for our package for vanilla JavaScript apps and @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

    2. Install the Grammarly Text Editor SDK:

      npm install @grammarly/editor-sdk-react
    3. Add the Grammarly Text Editor Plugin to your text editors by wrapping them with the GrammarlyEditorPlugin component:

      import React from "react";
      import { GrammarlyEditorPlugin } from "@grammarly/editor-sdk-react";
      
      export function GrammarlyEditor() {
        return (
          <GrammarlyEditorPlugin clientId="YOUR_CLIENT_ID">
            <textarea></textarea>
          </GrammarlyEditorPlugin>
        );
      }

    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:

    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.

    Install

    npm i @grammarly/editor-sdk-react

    DownloadsWeekly Downloads

    7,164

    Version

    2.3.0

    License

    Apache-2.0

    Unpacked Size

    26.5 kB

    Total Files

    7

    Last publish

    Collaborators

    • bgschiller
    • grammarly-npm-admin
    • grammarly-npm-ci
    • gr_artifactory
    • it_grammarly
    • michael.chernetsov
    • rahul.kadyan
    • dhirtle