# @atlaskit/editor-plugin-help-dialog 中文文档

规范地址：https://npmcn.com/package/%40atlaskit/editor-plugin-help-dialog/

版本：30\.0\.16
npm 元数据更新时间：2026-11-07T01:24:22.117Z
中文译文更新时间：2026-11-07T02:50:15.577Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/editor-plugin-help-dialog
原文对照：https://npmcn.com/package/%40atlaskit/editor-plugin-help-dialog/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-mirror

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

- 包体积（解压后）：234 kB，92 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：17 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，react-intl ^5\.25\.1 \|\| ^6\.0\.0 \|\| ^7\.0\.0，@atlaskit/editor-common ^134\.9\.0
- 首次发布：2023-10-04T08:33:49.272Z
- 最新版本发布：2026-11-07T01:24:21.868Z
- 近 30 天下载量：33199（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：431（近 12 个月 297 个）

## 中文简介

@atlaskit/editor-core的帮助对话框插件

## 安装

```sh
npm install @atlaskit/editor-plugin-help-dialog
```

也可以使用：`pnpm add @atlaskit/editor-plugin-help-dialog`、`yarn add @atlaskit/editor-plugin-help-dialog`、`bun add @atlaskit/editor-plugin-help-dialog`

## README

# 编辑器插件帮助对话框

@atlaskit/editor-core的帮助对话框插件

**说明:** 这一构成部分是为阿特拉斯系统内部开发而设计的. 外部捐助者将能够使用这一构成部分,但无法提交问题.

## 概览

Help Dialog插件提供了一个交互式模式界面,可以显示编辑器特性,键盘快捷键和格式化选项等有用的信息. 它与编辑器的快速插入功能相融合,并基于图像上传和AI能力等可用特性支持动态配置.

## 主要特点

-   **帮助对话框模式** - 用格式化快捷键和编辑器提示显示全面的帮助界面
-   **键盘快捷键** - 使用键盘快捷键打开/关闭帮助对话框(?)
-   **特性检测** - 根据启用的功能(图像上传、AI)动态调整帮助内容
-   **快速插入整合** - 通过快速插入菜单访问帮助对话框
-   **国家管理** - 跟踪和管理帮助对话框的能见度状态
-   **键盘导航** - 关闭与逃逸键的对话,以更好地获取

## 安装

* * *

-   **安装** - 说吧 _线条 添加 @ atlaskit/ editor- plugin- help- dialog_
-   **无** - 说吧 [@atlaskit/editor-plugin-help-dialog 页面存档备份,存于互联网档案馆 相接地铁站](https://www.npmjs.com/package/@atlaskit/editor-plugin-help-dialog)
-   **来源** - 说吧 [键盘](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-help-dialog)
-   **套装** - 说吧 [unpkg.com (英语)](https://unpkg.com/@atlaskit/editor-plugin-help-dialog/dist/)

## 使用量

* * *

**仅内部使用**

@atlaskit/editor-plugin-help-dialog是供@atlaskit/editor-core内部使用,并作为您产品中编辑器的插件依赖.

不支持直接使用此组件.

请看 [Atlaskit - 编辑器插件帮助对话框](https://atlaskit.atlassian.com/packages/editor/editor-plugin-help-dialog) 用于此软件包的文档和示例.

## 支助

* * *

对于内部阿特拉斯人, 访问懒惰的通道 [\# 帮助编辑器 #](https://atlassian.slack.com/archives/CFG3PSQ9E) 支助或访问 [去/编辑-帮助](https://go/editor-help) 以提交错误.

## 许可证

* * *

请看 [阿特拉斯前端 - 许可证](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) 获取更多的许可证信息.

## 常见问题

### @atlaskit/editor-plugin-help-dialog 是什么？

@atlaskit/editor-core的帮助对话框插件

### 如何安装 @atlaskit/editor-plugin-help-dialog？

在项目目录运行 npm install @atlaskit/editor-plugin-help-dialog，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0 \|\| ^19\.2\.0）、react-intl（^5\.25\.1 \|\| ^6\.0\.0 \|\| ^7\.0\.0）、@atlaskit/editor-common（^134\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atlaskit/editor-plugin-help-dialog 支持 TypeScript 吗？

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

### @atlaskit/editor-plugin-help-dialog 支持 ESM 还是 CommonJS？

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

### @atlaskit/editor-plugin-help-dialog 可以商用吗？

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

### @atlaskit/editor-plugin-help-dialog 的下载量有多少？

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

### @atlaskit/editor-plugin-help-dialog 还在维护吗？

最新版本 30\.0\.16 发布于 2026/11/07（今天）；至今共发布 431 个版本，其中过去 12 个月发布了 297 个；首次发布于 2023/10/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

