# @guardian/prosemirror-invisibles 中文文档

规范地址：https://npmcn.com/package/%40guardian/prosemirror-invisibles/

版本：3\.1\.3
npm 元数据更新时间：2026-04-07T08:46:45.671Z
中文译文更新时间：2026-11-17T08:54:39.689Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40guardian/prosemirror-invisibles
原文对照：https://npmcn.com/package/%40guardian/prosemirror-invisibles/?lang=original
项目主页：https://github.com/guardian/prosemirror-invisibles#readme
源码仓库：https://github.com/guardian/prosemirror-invisibles

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

- 包体积（解压后）：646 kB，57 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：prosemirror-model ^1\.18\.2，prosemirror-state ^1\.4\.2，prosemirror-view ^1\.29\.1
- 首次发布：2018-08-22T09:33:21.940Z
- 最新版本发布：2026-04-07T08:46:45.197Z
- 近 30 天下载量：4938（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 1 个）

## 中文简介

在 prosemiror 中显示隐形物的插件

## 安装

```sh
npm install @guardian/prosemirror-invisibles
```

也可以使用：`pnpm add @guardian/prosemirror-invisibles`、`yarn add @guardian/prosemirror-invisibles`、`bun add @guardian/prosemirror-invisibles`

## README

# 亲子隐形人

简单执行隐形字符 [表达器](https://prosemirror.net/)。 。 。 .

演示 [在这里.](https://guardian.github.io/prosemirror-invisibles/)

* * *

## 安装

`npm install @guardian/prosemirror-invisibles`

## 使用量

将插件添加到状态并传递您要在文档中显示的隐形物 .

```javascript
import invisibles, { space, hardBreak, paragraph } from 'prosemirror-invisibles';

new EditorView(document.querySelector("#editor"), {
  state: EditorState.create({
    doc: DOMParser.fromSchema(mySchema).parse(
      document.querySelector("#content")
    ),
    plugins: [
      invisibles([space(), hardBreak(), paragraph()])
    ]
  })
});
```

并导入 CS 从 `prosemirror-invisibles/dist/invisibles.css`。 。 。 .

## 关于破行隐形和选择的说明

在写作时,Chrome,Firefox和Safari都提供有限的反馈,在进行包含换行的选取时——选择和光标在分出内容后才会改变. 下面可以看到一个选择位置, 包括用户看不见的断线:

![No clear indication when we've selected across the paragraph boundary. Taken in Firefox](https://user-images.githubusercontent.com/7767575/196673262-27f8bd5f-ea43-4139-805e-59576d06aaab.gif)

这对代表换行(段落,软回等)的隐形字符来说是成问题的——我们必须包括换行的隐形符,当它们成为选择的一部分时,或者我们冒着误导用户的风险,暗示换行符不在选择的一部分.

将内容包含在代表无形字符的装饰中会给布局和光标行为带来问题,因此目前我们通过在这些装饰中加入一个附加的跨度来作假,当它们成为选择的一部分. 然后我们可以在跨度上增加一个宽度,并给它一个与文本选择相同的背景颜色. 这把拐杖让我们有了我们期望的行为:

![Selecting invisibles provides a clear indication when we've selected across the paragraph boundary. Taken in Firefox](https://user-images.githubusercontent.com/7767575/196673269-9f8794a6-91c0-432b-a4c6-ec54a9a12e40.gif)

在您自己的编辑器中修改这种造型可能是必要的,以确保冒号的颜色和大小正确. 如果这种行为不可取,我们建议取消这种风格。 最后,我们希望这个问题得到更好的解决——任何建议都非常受欢迎!

## 本地运行

要在当地运行沙盒 :

`yarn watch`

## 常见问题

### @guardian/prosemirror-invisibles 是什么？

在 prosemiror 中显示隐形物的插件

### 如何安装 @guardian/prosemirror-invisibles？

在项目目录运行 npm install @guardian/prosemirror-invisibles，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：prosemirror-model（^1\.18\.2）、prosemirror-state（^1\.4\.2）、prosemirror-view（^1\.29\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @guardian/prosemirror-invisibles 支持 TypeScript 吗？

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

### @guardian/prosemirror-invisibles 支持 ESM 还是 CommonJS？

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

### @guardian/prosemirror-invisibles 可以商用吗？

@guardian/prosemirror-invisibles 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @guardian/prosemirror-invisibles 的下载量有多少？

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

### @guardian/prosemirror-invisibles 还在维护吗？

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

