EditorSDK
Overall API for the Editor SDK which can be used to create an Editor, which represents an HTML editor enhanced with Grammarly.
declare class EditorSDK {
addPlugin(element: HTMLElement, config?: EditorConfig, viewport?: HTMLElement): GrammarlyEditorPluginElement;
handleOAuthCallback(url: string): Promise<void>;
}
Examples
const Grammarly = await init("YOUR_CLIENT_ID");
const grammarlyPluginElement = Grammarly.addPlugin(document.querySelector("textarea"));
Methods
addPlugin()
Enhance a specific HTML element with Grammarly.
addPlugin(element: HTMLElement, config?: EditorConfig, viewport?: HTMLElement): GrammarlyEditorPluginElement;
Parameters
Name | Type | Description |
---|---|---|
element | HTMLElement | Element to be enhanced |
config | EditorConfig | Optional EditorConfig |
viewport | HTMLElement | Parent scrolling element, if different from editor element (since 1.6.7) |
handleOAuthCallback()
Process OAuth callback and complete account connection.
handleOAuthCallback(url: string): Promise<void>;
Parameters
Name | Type | Description |
---|---|---|
url | string |