# @grammarly/editor-sdk 中文文档

规范地址：https://npmcn.com/package/%40grammarly/editor-sdk/

版本：2\.5\.5
npm 元数据更新时间：2025-11-04T15:20:44.571Z
中文译文更新时间：2026-11-17T03:28:34.576Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40grammarly/editor-sdk
原文对照：https://npmcn.com/package/%40grammarly/editor-sdk/?lang=original
项目主页：https://developer.grammarly.com/docs
源码仓库：https://github.com/grammarly/grammarly-for-developers

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：96.6 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-04-22T22:58:06.617Z
- 最新版本发布：2023-10-20T23:45:16.628Z
- 近 30 天下载量：7687（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：120（近 12 个月 0 个）

## 中文简介

格鲁玛利为网络编辑撰写 SDK

## 安装

```sh
npm install @grammarly/editor-sdk
```

也可以使用：`pnpm add @grammarly/editor-sdk`、`yarn add @grammarly/editor-sdk`、`bun add @grammarly/editor-sdk`

## README

# 语法文本编辑器 SDK

在您的应用程序中加入格鲁玛利的实时写作支持,只需要几行代码.

![A code snippet shows how to add the Grammarly Text Editor Plugin to a textarea. Then an animation of a user accepting a Grammarly suggestion in a chat app appears.](https://github.com/grammarly/grammarly-for-developers/blob/main/docs/sdk_product_animation.gif?raw=true)

这个包是为香草JavaScript应用设计的. 访问 [@ grammarly/editor-sdk-反应](https://www.npmjs.com/package/@grammarly/editor-sdk-react) 我们的软件包 反应应用程序和 [@ 语法/编辑-sdk-vue](https://www.npmjs.com/package/@grammarly/editor-sdk-vue) 为了我们的包 Vue应用程序.

## 开始

下面是怎样开始:

1.  创建新 [开发者应用的语法](https://developer.grammarly.com/apps?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js)
    
2.  安装语法文本编辑器 SDK :
    
    ```bash
    npm install @grammarly/editor-sdk
    ```
    
3.  用您的客户端ID初始化 SDK :
    
    ```ts
    import * as Grammarly from "@grammarly/editor-sdk";
    
    Grammarly.init("YOUR_CLIENT_ID");
    ```
    
4.  在文本编辑器中添加语法文本编辑器插件 [语法编辑或插件](https://developer.grammarly.com/docs/api/editor-sdk/grammarlyeditorpluginelement?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js) 网页组件.
    
    ```ts
    <grammarly-editor-plugin>
      <textarea></textarea>
    </grammarly-editor-plugin>
    ```
    

## 学多点

如果您想了解更多关于SDK的操作方法以及如何自定义您的应用的插件,请访问:

-   [开发者文档的语法](https://developer.grammarly.com/docs/?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js)
-   [开发者 API 语法参考](https://developer.grammarly.com/docs/api/editor-sdk/?utm_source=npm&utm_medium=developer&utm_campaign=readme-js&utm_term=grammarly-js)
-   [GitHub 上的开发者规范示例](https://github.com/grammarly/grammarly-for-developers)

## 问个问题

如果你想问一个问题,分享一个建议,或者聊天,你是如何在您的应用程序中使用语法文本编辑器SDK的,请加入我们 [GitHub 上的开发者的语法](https://github.com/grammarly/grammarly-for-developers/discussions)。 。 。 .

## 常见问题

### @grammarly/editor-sdk 是什么？

格鲁玛利为网络编辑撰写 SDK注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @grammarly/editor-sdk？

在项目目录运行 npm install @grammarly/editor-sdk，或使用 pnpm add / yarn add / bun add。

### @grammarly/editor-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @grammarly/editor-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @grammarly/editor-sdk 可以商用吗？

@grammarly/editor-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @grammarly/editor-sdk 的下载量有多少？

根据 npm 官方下载统计，@grammarly/editor-sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 7,687 次，日均约 256 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @grammarly/editor-sdk 还在维护吗？

最新版本 2\.5\.5 发布于 2023/10/21（3 年前）；至今共发布 120 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/04/23。作者已将其标记为弃用，新项目建议寻找替代方案。

