# @farscrl/tiptap-extension-spellchecker 中文文档

规范地址：https://npmcn.com/package/%40farscrl/tiptap-extension-spellchecker/

版本：2\.0\.2
npm 元数据更新时间：2026-07-23T09:01:02.305Z
中文译文更新时间：2026-11-14T10:43:57.604Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：83.7 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@tiptap/core ^3\.0\.1
- 首次发布：2022-08-29T09:33:40.723Z
- 最新版本发布：2026-07-23T09:01:02.103Z
- 近 30 天下载量：6871（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 2 个）

## 中文简介

TipTap 编辑器的拼写检查扩展名

## 安装

```sh
npm install @farscrl/tiptap-extension-spellchecker
```

也可以使用：`pnpm add @farscrl/tiptap-extension-spellchecker`、`yarn add @farscrl/tiptap-extension-spellchecker`、`bun add @farscrl/tiptap-extension-spellchecker`

## README

# Tittap 拼写检查器扩展

这是将拼写检查器整合到 [倾斜](https://tiptap.dev/) 编辑.

扩展名本身不执行拼写检查器: 您必须传递它一个执行拼写检查器的校验对象 `IProofreaderInterface` 接口。 这个校验器可以在浏览器中局部工作,也可以调用在线服务,或者任何你想用作拼写检查服务的东西.

要求数 `@tiptap/core` `^3.0.1` 已经安装在您的工程中 .

## 安装

使用 npm 安装依赖 :

```bash
npm install @farscrl/tiptap-extension-spellchecker
```

或使用pnpm:

```bash
pnpm add @farscrl/tiptap-extension-spellchecker
```

## 使用量

将扩展名包含在您的平面编辑器配置中 :

```typescript
import { Editor } from '@tiptap/core';
import StarterKit from '@tiptap/starter-kit';
import SpellcheckerExtension, { IProofreaderInterface, ITextWithPosition } from '@farscrl/tiptap-extension-spellchecker';

const myProofreader = new Proofreader(); // implementing IProofreaderInterface

new Editor({
    extensions: [
        StarterKit,
        SpellcheckerExtension.configure({
            proofreader: myProofreader,
            uiStrings: {
                noSuggestions: 'No suggestions found'
            }
        })
    ],
});
```

执行 `IProofreaderInterface` 插入您自己的拼写检查逻辑 :

```typescript
interface ITextWithPosition {
    offset: number;
    length: number;
    word: string;
}

interface IProofreaderInterface {
    // find misspelled words in a sentence
    proofreadText(sentence: string): Promise<ITextWithPosition[]>;
    // return suggestions for a misspelled word
    getSuggestions(word: string): Promise<string[]>;
    // normalize text (e.g. strip accents/casing) before it's checked
    normalizeTextForLanguage(text: string): string;
}
```

### 配置选项

-   **校对器** (必须): 执行 `IProofreaderInterface` 接口
-   **用户串** (可选):用于扩展最小UI的字符串. 如果不提供,则使用默认字符串.
-   **显示建议活动** (可选) : `(word: string) => void` 当建议框显示拼写错误的单词时, 调用回调

### 图标

扩展注册这些编辑器命令 :

-   **检查Spelling ()**: 对整个文档重新运行拼写检查器
-   **全部选择( E)**: 选择整个文档内容
-   **副本( )**: 将当前选择复制到剪贴板

```typescript
editor.commands.checkSpelling();
```

### 样式

分机不载运任何CSS. 拼错的单词以 `spell-error` 分类,建议降级作为 `#suggestions-box` 包含 a 的元素 `ul.suggestion-list` ——您需要为两者添加自己的风格,否则扩展没有明显效果. 最低起点:

```css
.spell-error {
    text-decoration: underline wavy red;
}

#suggestions-box {
    position: absolute;
    border: 1px solid black;
    background-color: #f7f7f7;
    border-radius: 4px;
}

#suggestions-box ul {
    padding: 2px 4px;
    margin: 0;
    display: inline-block;
}

#suggestions-box li {
    cursor: pointer;
    list-style: none;
}
```

见 `demo/src/css.css` 一个更完整的例子.

## 演示

可在 `demo` 文件夹 : 使用本地、 浏览器词典( i)`local`),一名呼叫一个以洪斯佩尔为基地的检查员(`hunspell`) (中文(简体) ). 要运行他们:

```bash
# Clone the repository
git clone https://github.com/farscrl/tiptap-extension-spellchecker.git
cd tiptap-extension-spellchecker

# Install dependencies
pnpm install

# Build the extension
pnpm run build

# Run the demo
cd demo
pnpm install
pnpm start
```

演示将在您的浏览器中打开, 显示正在操作的拼写检查器 .

## 发展

### 大楼

构建类型脚本来源 :

```bash
pnpm run build
```

### 测试

运行测试套件 :

```bash
pnpm run test
```

### 线性

检查代码质量 :

```bash
pnpm run lint
```

## 出版

要发布新版本 :

1.  弹出 `version` 内 `package.json`。 。 。 .
2.  为新版本添加一个日期条目 `CHANGELOG.md`。 。 。 .
3.  提交两个文件为 `chore: prepare version X.Y.Z`。 。 。 .
4.  输入的标记 : `git tag vX.Y.Z` 推着它: `git push --tags`。 。 。 .
5.  运行 `npm publish` (单位:千美元) `prepare` 脚本构建 `lib/` 发布前自动).

## 贷项

此扩展来自 [提示语言工具](https://github.com/sereneinserenade/tiptap-languagetool) 扩展名.

## 许可证

麻省理工学院

## 常见问题

### @farscrl/tiptap-extension-spellchecker 是什么？

TipTap 编辑器的拼写检查扩展名

### 如何安装 @farscrl/tiptap-extension-spellchecker？

在项目目录运行 npm install @farscrl/tiptap-extension-spellchecker，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@tiptap/core（^3\.0\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @farscrl/tiptap-extension-spellchecker 支持 TypeScript 吗？

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

### @farscrl/tiptap-extension-spellchecker 支持 ESM 还是 CommonJS？

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

### @farscrl/tiptap-extension-spellchecker 可以商用吗？

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

### @farscrl/tiptap-extension-spellchecker 的下载量有多少？

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

### @farscrl/tiptap-extension-spellchecker 还在维护吗？

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