@grammarly/editor-sdk-vue

Grammarly Text Editor SDK for Vue

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

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:

• Grammarly for Developers Documentation
• Grammarly for Developers API Reference
• Grammarly for Developers Code Examples on GitHub

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.