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

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

版本：30\.0\.2
npm 元数据更新时间：2026-11-02T05:50:00.051Z
中文译文更新时间：2026-11-07T02:56:21.925Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：73.1 kB，43 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，react-dom ^18\.2\.0 \|\| ^19\.2\.0，@atlaskit/editor-common ^134\.4\.0
- 首次发布：2023-05-24T07:08:07.140Z
- 最新版本发布：2026-11-02T05:49:59.869Z
- 近 30 天下载量：29030（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：133（近 12 个月 45 个）

## 中文简介

@atlaskit/ editor- core 的准则插件

## 安装

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

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

## README

# 编辑器插件准则

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

## 概览

指针插件提供了在编辑器中显示垂直指针的能力. 准则作为垂直线在特定位置提供,可按不同样式和状态定制。 此插件的设计仅包含基本逻辑以渲染出准则. 常用的配置和水电设施位于 `editor-common` 软件包.

## 主要特点

-   **显示指南** - 在编辑器内指定位置调整垂直准则
-   **灵活定位** - 使用坐标值相对于编辑中心的位置指南
-   **自定义样式** - 配置行样式(固态/干态)、颜色和盖样式
-   **国家管理** - 控制可见度和各项准则的活跃状态
-   **插件集成** - 使用宽度插件计算正确的定位

## 安装

```
yarn add @atlaskit/editor-plugin-guideline
```

-   **无** - 说吧 [@atlaskit/editor-plugin-指针](https://www.npmjs.com/package/@atlaskit/editor-plugin-guideline)
-   **来源** - 说吧 [键盘](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-guideline)

## 使用量

### 基本示例

```typescript
pluginInjectionApi?.dependencies?.guideline?.actions?.displayGuideline(view)({
  guidelines: [{
    key: "guideline_01",
    position: {
      x: -100
    },
    active: true,
    style: "dashed",
    color: "rgba(0, 0, 0, 0.2)"
  }, 
  {
    key: "guideline_02",
    position: {
      x: 300
    },
    show: false
  }]
});
```

### 准则配置

准则配置由三部分组成:

-   **密钥** (要求) - 准则的独特标识符
-   **职位** (要求) - 准则的x坐标立场
-   **州/区** (可选) - 显示状态和样式选项

### 职位

位置值定义为: `type Position = { x: number };`

位置图 :

```
  │                   editor width                    │
  │------------------- max 1800px --------------------│
  │                                                   │
  │          center line (when position x=0)          │
  │                         │                         │
  │--------- x < 0 ---------│--------- x > 0 ---------│
  │                         │                         │
  ┌────────────┬────────────┬────────────┬────────────┐
  │            │            │            │            │
  │            │            │            │            │
  │            │            │            │            │
  │            │-- 380px ---│--- 380px --│            │
  │            │            │            │            │
  │            │            │            │            │
  │            │            │            │            │
  └────────────┴────────────┴────────────┴────────────┘
               │      editor content     │
               │-------- max 760px ------│
  │---------- or 1800px in full-width mode  ----------│
```

-   何时 `x` 0,在编辑器中心显示垂直行
-   负值会移动左行( 最多为编辑器宽度的下半部分)
-   正值将行向右移动(最多为编辑器宽度的一半)
-   忽略可见范围以外的准则

### 状态和样式

配置下列状态和样式选项的指南 :

```typescript
type GuidelineConfig = {
  // ...
  active?: boolean;           // default false
  show?: boolean;             // default true
  styles?: {
    lineStyle?: 'dashed' | 'solid';  // default 'solid'
    color?: CSSToken;                // default undefined
    capStyle?: 'line'                // default undefined
  }
};
```

-   `active` - 等同网格插件中的亮点状态
-   `show` - 隐藏指南(用于动画)
-   `styles.color` - 用有效的 CSS 颜色来覆盖导线颜色
-   `styles.lineStyle` - 线条样式可以是“ 固态” 或“ dashed ”
-   `styles.capStyle` - 线盖样式,支持“行”

## 支助

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

## 许可证

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

## 常见问题

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

@atlaskit/ editor- core 的准则插件

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

在项目目录运行 npm install @atlaskit/editor-plugin-guideline，或使用 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\.4\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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