Grammarly Text Editor SDK for Vue

This doc explains how to integrate the Grammarly Text Editor SDK with a Vue application.

For more guidance, you may also want to check out the following resources:


npm install @grammarly/editor-sdk-vue


To add the Grammarly Text Editor Plugin, wrap editor components with GrammarlyEditorPlugin.

Only editor components powered by the following HTML elements are supported:

  • <input type='text'>
  • <textarea> that are not readonly or disabled
  • contenteditable="true" that are not readonly or disabled

If your app has multiple text editors where you want to add the plugin, use the Grammarly wrapper to pass clientId and other configuration once.

Vue 3

<script setup>
import { GrammarlyEditorPlugin } from "@grammarly/editor-sdk-vue";

  <GrammarlyEditorPlugin clientId="YOUR_CLIENT_ID">
    <textarea />

Vue 2

import { GrammarlyEditorPlugin } from "@grammarly/editor-sdk-vue/v2";

export default {
  components: { GrammarlyEditorPlugin },

  <GrammarlyEditorPlugin clientId="YOUR_CLIENT_ID">
    <textarea />

You can view an interactive example on CodeSandboxopen in new window.

For additional configuration details, please visit the API reference for Vue 2 and Vue 3.

Integrating with rich text editor frameworks

We regularly test the Text Editor SDK for Vue for compatibility with TinyMCE 6 and CKEditor 5.

As described above, wrap rich text editor elements with <GrammarlyEditorPlugin>. Set any configuration options using the Grammarly wrapper or the GrammarlyEditorPlugin component.

Here is sample code to get started:


The Text Editor SDK supports Vue 2 versions 2.5 and later, and the SDK supports Vue 3, the latest major version of Vue.

Preparing for production

Before making your app available in a production environment, please take note of the recommendations in Securing Your Integration.

Last Updated: 6/6/2023, 12:27:11 AM