@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="{ document: { dialect: '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

  • Grammarly — An optional context provider for GrammarlyEditorPlugin.
  • GrammarlyEditorPlugin — Component that enhances textareas, inputs or contenteditables with the Grammarly experience.
  • GrammarlyProps — Props for <GrammarlyEditorPlugin>
Last Updated: 10/14/2021, 7:00:57 PM