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

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

版本：15\.0\.0
npm 元数据更新时间：2026-10-27T02:04:12.568Z
中文译文更新时间：2026-11-07T03:08:38.114Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：213 kB，71 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，@atlaskit/editor-common ^134\.0\.0
- 首次发布：2026-08-14T09:39:40.740Z
- 最新版本发布：2026-10-27T02:04:11.846Z
- 近 30 天下载量：11117（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 25 个）

## 中文简介

@ atlaskit/ editor- core 的交互插件

## 安装

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

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

## README

# 编辑器插件交互

@ atlaskit/ editor- core 的交互插件

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

## 概览

交互插件报告 `editor interactivity` 业务活动:会期至今 全页编辑器会话的 互动空闲分布 [RFC 095 (法语)](https://hello.atlassian.net/wiki/spaces/EDITOR/pages/7527607488/Editor+RFC+095+Confluence+editor+responsiveness+bucketed+INP+telemetry)。 。 。 . 每个会话报告一个值的信号不能回答多少次相互作用是缓慢的,所以 插件保留了桶数 .

## 报告的内容

-   `page` - 页面上的每一次互动,例如: `totalCount`, (中文(简体) ), `observedCount`, (中文(简体) ), `sumMs`, (中文(简体) ), `maxMs`, (中文(简体) ), `buckets` 财务报告和审定财务报表 `percentilesMs`。 。 。 . `totalCount` 来自 `performance.interactionCount` 包含 16 ms以下的相互作用 `totalCount - observedCount` 实值 子门槛数. `percentilesMs` 军衔 `totalCount`正如INP所做的,所以百分位数 属于分阈值的相互作用为16.
-   `editorTyping`, (中文(简体) ), `editorPointer` 财务报告和审定财务报表 `editorOther` ——与编辑的互动,在同 形状为 `page`事件时间观察整个文件,因此 `page` 一个人不能说是否 回归在编辑器或页面的其他地方;这些可以. 与编辑器的每次互动 完全在其中之一,而且 `page` 还有.
-   `editor` ——三个编辑组为一,形状相同:每会话的编辑p98为: 这是他们不能给的.
-   `percentilesMs` 相同相互作用的百分位数,按百分位数键,精确到8毫秒 时间安排报告持续时间;每次会议的衡量尺度是: `buckets`。 。 。 .
-   Bucket 键是桶以毫秒计的上界, 只计算上方的相互作用 上一个边界。 桶不是累积的,空桶是省略的,所以不见了 桶即为零. 边界由 `schema`。 。 。 .
-   抓图是当前会话, 因此组群查询需要最高 `seq` 百分比 `interactivitySessionId` 然后数起桶子.

## 编辑组

交互是编辑器的 当它发生在编辑器 自己制造的元素, 将编辑器核心手放在插件的钩子上作为 `wrapperElement`第二名观察员报告: 事件时间观察员报告 迟到 追踪器进行互动.

编辑们的事件是数 互动,因为没有 `performance.interactionCount` 每个组和16毫秒报告阈值是最小的光谱 允许。 交互是数个事件,所以算在其中之一上: 输入 `keydown`, (中文(简体) ), 因为一个持有的密钥重复,浏览器计算每一次重复; 指向 `pointerup`,因为 由卷轴接管的磁盘从来就得不到一个——浏览器也算不上它的相互作用. 该组来自同一事件, 和一个表格在 `interaction-events.ts` 改为两者 计数和分组,所以两者不能有分歧.

一个条目在它测量的一组事件中着陆,与该事件的类型和时间戳相匹配. 一个 编辑器从未报告的事件的交互 `page` 只有这个.

已知的漏洞,所有这些漏洞只将编辑组的相互作用移出,而永不相互间:

-   编辑器在这个元素之外所做的——一个下拉或一个门户中的对话框——被计算在内 `page` 就像元素到达前的一切 编辑器先作画后的渲染.
-   `editorOther` 是所剩槽:浏览器只计算键盘和指针交互 今天,它读作零 直到这个变化.
-   当一个 IME 作曲时,浏览器可以将密钥组合成比我们数的更少的互动,所以 `editorTyping.totalCount` 可以领先它.

## 低调

在会话开始后拍摄10秒、30秒和60秒,然后每60秒,加上每秒 将标签转换为隐藏, 打开 `pagehide` 在编辑器上卸载。 一个会重复的快照 上一个被跳过,一个生命周期过渡的信号被连为单个 示意图.

## 会议

一个会话以一种方式覆盖一个文件,因此其后期总是相互可比. 它通常会持续编辑器挂载,但也会在编辑器挂载时结束 - 在阅读和编辑之间进行浏览和切换,而不包含 正在重挂编辑器 。 报告为: `reason: 'navigation'` 或者说 `reason: 'modeChange'`,则 下一个会话开始为新 `interactivitySessionId`一个编辑器的会话共享 `editorSessionId`缝合起来.

## 安装

* * *

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

## 使用量

* * *

**仅内部使用**

@atlaskit/editor-plugin-interactive 供内部使用 作为您产品中编辑器的插件依赖.

不支持直接使用此组件.

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

## 支助

* * *

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

## 许可证

* * *

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

## 常见问题

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

@ atlaskit/ editor- core 的交互插件

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

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

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

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

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

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

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

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

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

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

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

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