Glossary
A glossary of terms relevant to the Grammarly for Developers platform.
App Console
- Where you can manage settings and view information related to your Grammarly for Developers app. Access it by selecting your application from My Apps.
Dictionaries
- A feature that lets you specify words that Grammarly should not flag as misspelled for users of your app. Only available for apps on the Plus plan.
App owner
- The person who created your Grammarly for Developers app. They are the only person who can delete the app or manage collaborators.
Autocomplete
- A feature you can turn on to let users receive suggestions to complete common phrases as they type. Only available for apps on the Plus plan.
Client
- The interface that accesses Grammarly's services. Your app needs separate clients for web and desktop. All clients have their own credentials.
Collaborators
- Team members you can invite to view your application and manage its settings.
Configuration
- Custom theming and settings that you can apply to the Grammarly Text Editor Plugin.
Configurator
- A demo environment where you can test and share different color, theme, and feature settings for the Grammarly Text Editor Plugin.
Connected accounts
- A feature you can turn on to let Grammarly users sign into their Grammarly accounts when using your app, rather than receiving the same experience as anonymous users.
Credentials
- Your client ID and any configured origins (for web clients) and redirect URIs (for desktop clients). Used for credentials-based authentication.
Dashboard
- An analytics page that shows how your users interact with the Grammarly Text Editor Plugin in your app. Accessible from the App Console.
Dialect
- The variety of English (e.g., British English, Canadian English) that Grammarly uses to analyze text. Can be configured in the SDK and by individual users.
Domain
- The style or type of writing (e.g., Academic, Email) that best applies to the text. Can be configured in the SDK.
Editor
- An interface where users can input and edit text. To integrate with the SDK, an editor must conform to either
input type='text'
,textarea
, orcontenteditable='true'
; (and notreadonly
ordisabled
). Error Explainer
- A webpage that loads the SDK's full error message for certain error codes, which are passed in as query parameters. Some error messages in the console will link you to this page for more information.
Grammarly Business
- A type of Grammarly user account that offers advanced features for teams, such as a company style guide. Gray underlines highlight style guide suggestions.
- The 'G' button in your Grammarly for Developers app shows the status of Grammarly's suggestions and opens a settings menu.
- A type of Grammarly user account that offers advanced writing assistance features.
Grammarly browser extension
- A Grammarly product offering that lets users get Grammarly suggestions wherever they write on the web. If a user has it installed, the Grammarly browser extension will override the Grammarly Text Editor Plugin experience.
Grammarly for Developers
- The platform that provides tools for developers to integrate Grammarly's communication assistance into their applications.
Grammarly for Developers App
- An application that is registered with the Grammarly for Developers platform. Appears in My Apps.
Grammarly Text Editor Plugin
- A web component that you can add to any text editor or input area to provide real-time writing suggestions for your users.
Grammarly Text Editor SDK
- The suite of functions and services that bring real-time writing suggestions to any text editors inside your app. Available as an npm package for vanilla JavaScript, React, or Vue, and also works with desktop apps using Electron.
JWT (JSON Web Token)
- An open standard for securely transmitting information between parties as a JSON object that is digitally signed. Apps that use trusted authentication need to generate JWTs.
Origin
- For a web app, a defined scheme, hostname, and port that is permitted to communicate with Grammarly's cloud using your application's client ID.
Personal dictionary
- A feature that lets signed-in users add unique words or stop flagging a particular spelling of a word as incorrect. Available to users who sign in via connected accounts.
Plan
- Either Free or Plus, your plan controls what Grammarly features your app can access. See our plans page.
Redirect URIs
- For a desktop app, the URIs Grammarly can redirect to after a user attempts to connect their Grammarly account to your application. Redirect URIs are needed to turn on connected accounts for your desktop application.
Rich text editor
- A type of editor that allows users to style text using a 'what-you-see-is-what-you-get' interface (rather than HTML). Grammarly supports rich text editors built with a variety of modern frameworks.
Suggestion
- An improvement to the user's text surfaced by Grammarly. Suggestions are shown using underlines and cards. Users can accept, dismiss, or ignore suggestions. See examples of suggestions here.
Suggestion cards
- Appear when a user hovers over an underline, showing information about the change Grammarly is suggesting to improve the user's writing.
Suggestion underlines
- Appear below words and phrases where Grammarly has a suggestion. Different colors of underlines indicate different kinds of suggestions
Tone detector
- A feature you can turn on to have Grammarly show the user what tone it detects in their text. Only available for apps on the Plus plan plan.
Trusted authentication
- An additional layer of security you can implement that uses assertions signed with public/private keys to authenticate every connection that your app makes with Grammarly.
Words analyzed
- The total number of words that have been processed in your application via the Grammarly Text Editor SDK.