This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

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

2.5.5 • Public • Published

Grammarly Text Editor SDK for Vue

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 Vue apps. Visit @grammarly/editor-sdk for our package for vanilla JavaScript apps and @grammarly/editor-sdk-react for our package for React 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-vue
  3. Add the Grammarly Text Editor Plugin to your text editors by wrapping them with the GrammarlyEditorPlugin component:

    Vue 3

    <script setup>
    import { GrammarlyEditorPlugin } from "@grammarly/editor-sdk-vue";
    </script>
    
    <template>
      <GrammarlyEditorPlugin clientId="YOUR_CLIENT_ID">
        <textarea></textarea>
      </GrammarlyEditorPlugin>
    </template>

    Vue 2

    <script>
    import { GrammarlyEditorPlugin } from "@grammarly/editor-sdk-vue/v2";
    
    export default {
      components: { GrammarlyEditorPlugin },
    };
    </script>
    
    <template>
      <GrammarlyEditorPlugin clientId="YOUR_CLIENT_ID">
        <textarea></textarea>
      </GrammarlyEditorPlugin>
    </template>

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.

/@grammarly/editor-sdk-vue/

    Package Sidebar

    Install

    npm i @grammarly/editor-sdk-vue

    Weekly Downloads

    622

    Version

    2.5.5

    License

    Apache-2.0

    Unpacked Size

    44.4 kB

    Total Files

    17

    Last publish

    Collaborators

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