# @atlaskit/editor-plugin-rule 中文文档

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

版本：30\.0\.3
npm 元数据更新时间：2026-11-03T05:58:35.719Z
中文译文更新时间：2026-11-07T02:57:25.495Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：189 kB，98 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：20 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，react-dom ^18\.2\.0 \|\| ^19\.2\.0，@atlaskit/editor-common ^134\.5\.0
- 首次发布：2023-09-05T00:23:41.494Z
- 最新版本发布：2026-11-03T05:58:35.564Z
- 近 30 天下载量：27315（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：152（近 12 个月 49 个）

## 中文简介

@ atlaskit/ 编辑- 核心的规则插件

## 安装

```sh
npm install @atlaskit/editor-plugin-rule
```

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

## README

# 编辑器插件规则

@ atlaskit/ 编辑- 核心的规则插件

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

## 概览

规则插件为Atlassian编辑器提供水平规则(divider)插入能力. 它通过多种输入方法,包括键盘快捷键、快速插入和程序行动,使用户能够在文档中插入横向规则.

## 主要特点

-   **水平规则插入** - 在编辑内容中插入横向分隔符
-   **输入规则支持** - 使用键盘快捷键 `---` 快速插入规则
-   **快速插入整合** - 从快速插入菜单中获取水平规则
-   **动作 API** - 通过程序插入 `insertHorizontalRule` 动作
-   **分析跟踪** - 跟踪横向规则插入分析事件

## 安装

* * *

-   **安装** - 说吧 _线条 添加 @ atlaskit/ editor- plugin- rule_
-   **无** - 说吧 [@atlaskit/editor-plugin-rule (英语)](https://www.npmjs.com/package/@atlaskit/editor-plugin-rule)
-   **来源** - 说吧 [键盘](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-rule)
-   **套装** - 说吧 [unpkg.com (英语)](https://unpkg.com/@atlaskit/editor-plugin-rule/dist/)

## 使用量

* * *

**仅内部使用**

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

不支持直接使用此组件.

请看 [Atlaskit - 编辑器插件规则](https://atlaskit.atlassian.com/packages/editor/editor-plugin-rule) 用于此软件包的文档和示例.

## 支助

* * *

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

## 许可证

* * *

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

## 常见问题

### @atlaskit/editor-plugin-rule 是什么？

@ atlaskit/ 编辑- 核心的规则插件

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

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

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

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

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

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

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

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

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

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

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

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