@grammarly/editor-sdk

Overview

See the getting started guide for installation options.

Reference

• init(clientId, config) — Initialize Grammarly and start using SDK.
  
  
• BaseSuggestion —
• ClientId — Identifier used to authenticate with Grammarly.
• Config — Configuration to customize the Grammarly integration.
• Dialect — Specific variety of English being written.
• DocumentStats — Statistics about the user-entered text.
• EditorConfig — Configuration to customize the Grammarly integration per editor instance.
• Event — Custom event
• EventEmitter — Emits events much like Node's EventEmitteropen in new window.
• EventListener — Event handler callback
• InsertOperation —
• Markup — A list of MarkupChild.
• MarkupChild — Semantic markup like HTML but easier to parse and restricted to an allow list.
• RichText — Rich text format for representing documents and changes (based on Quill's deltaopen in new window).
• RichTextAttributes — Metadata or semantics for an InsertOperation.
• SDK — Establishes a connection with Grammarly and creates Sessions for further interaction.
• SessionEvents — Events emitted by Session.
• SessionStats — Statistics about the Grammarly session.
• SuggestionCategories — Categories of suggestions that can be muted.
• TextRange — A range of text represented by start and end offsets. Ranges are half open intervals [start, end), that means end is not included.
  
  
• PluginDisableReason deprecated — Provides more detail when the plugin is disabled by a user.
• SuggestionCategoriesDeprecated deprecated — Categories of suggestions that can be muted.
• TextStats deprecated — Statistics about the user-entered text.