@grammarly/editor-sdk-vue

Overview

See the Text Editor SDK for Vue guide for installation options.

The SDK for Vue is a thin wrapper around the Text Editor SDK that keeps the same basic API but provides it as a component: GrammarlyEditorPlugin. This component accepts an optional config prop to configure the SDK according to your app's needs:

<template>
  <GrammarlyEditorPlugin
    clientId="YOUR_CLIENT_ID"
    :config="{ documentDialect: 'british' }"
  >
    <textarea></textarea>
  </GrammarlyEditorPlugin>
</template>

To use Grammarly throughout your app, use the Grammarly context provider and give it the same props.

Refer to EditorConfig for full configuration details.

Theming

CSS variables that allow you to theme your app are detailed in Customization.

Reference

Name	Description
Grammarly	An optional context provider component for GrammarlyEditorPlugin.
GrammarlyButton	Show the Grammarly button in a custom position. The Grammarly button can only display once per page. Its location is set and displayed according to the earliest inclusion of <GrammarlyButton>.
GrammarlyButtonProps	Props for <GrammarlyButton>.
GrammarlyEditorPlugin	Component that enhances textareas, inputs or contenteditables with the Grammarly experience.
GrammarlyEditorPluginProps	Props for <GrammarlyEditorPlugin>.
GrammarlyProps	Props for <Grammarly>.