# @editorcn/editor 中文文档

规范地址：https://npmcn.com/package/%40editorcn/editor/

版本：0\.4\.1
npm 元数据更新时间：2026-11-08T14:21:41.217Z
中文译文更新时间：2026-11-13T07:05:47.518Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40editorcn/editor
原文对照：https://npmcn.com/package/%40editorcn/editor/?lang=original

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

- 包体积（解压后）：611 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18 \|\| ^19，react-dom ^18 \|\| ^19，@tiptap/pm \>=3\.0\.0 \<4，@tiptap/core \>=3\.0\.0 \<4，@tiptap/react \>=3\.0\.0 \<4，@base-ui/react ^1\.0\.0，@floating-ui/dom ^1\.6\.0，@tiptap/starter-kit \>=3\.0\.0 \<4，@tiptap/extension-link \>=3\.0\.0 \<4，class-variance-authority ^0\.7\.1，@tiptap/extension-underline \>=3\.0\.0 \<4，@tiptap/extension-placeholder \>=3\.0\.0 \<4
- 首次发布：2026-08-20T11:55:24.082Z
- 最新版本发布：2026-11-08T14:21:41.023Z
- 近 30 天下载量：6828（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

A 类 **工具栏样式** 以丰富文本编辑器为基础 [提示](https://tiptap.dev/) 带有shadcn/ui设计符号。 部分 [编辑器cn](https://editorcn.vercel.app/) 编辑套房.

## 安装

```sh
npm install @editorcn/editor
```

也可以使用：`pnpm add @editorcn/editor`、`yarn add @editorcn/editor`、`bun add @editorcn/editor`

## README

# @ editorcn/ 编辑

A 类 **工具栏样式** 以丰富文本编辑器为基础 [提示](https://tiptap.dev/) 带有shadcn/ui设计符号。 部分 [编辑器cn](https://editorcn.vercel.app/) 编辑套房.

## 特征

-   化合物成分 API`RichTextEditor`, (中文(简体) ), `RichTextEditor.Toolbar`, (中文(简体) ), `RichTextEditor.Content`页:1
-   20+ 内置工具栏控件( Bold, H1, Link, Undo等)
-   有可配置控制组的粘性工具栏
-   用类型脚本完全输入
-   通过 Tiptap 扩展可扩展
-   由 shadcn/ ui CSS 变量所建 — 匹配您的主题

## 安装

### 无

```bash
npm install @editorcn/editor @tiptap/react @tiptap/pm @tiptap/starter-kit @tiptap/extension-link
```

> **Tiptap v3 必须使用.** `@editorcn/editor` 以 Tiptap 为对象构建 **页:1**. 确保您的 `@tiptap/*` 软件包在 v3 上, 导入 `BubbleMenu`编号 :`FloatingMenu` 从 `@tiptap/react/menus` (没有) `@tiptap/react` root)),如果直接使用它们.

### 阴影登记册

```bash
npx shadcn@latest add @editorcn/editor
```

保证你 `components.json` 包括编辑器登记册:

```json
{
  "registries": {
    "@editorcn": "https://editorcn.vercel.app/r/{name}.json"
  }
}
```

## 使用量

```tsx
"use client";

import { useEditor } from "@tiptap/react";
import { StarterKit } from "@tiptap/starter-kit";
import { Underline } from "@tiptap/extension-underline";
import { RichTextEditor, Link } from "@editorcn/editor";
import "@editorcn/editor/style.css";

export function MyEditor() {
  const editor = useEditor({
    extensions: [StarterKit, Link, Underline],
    content: "<p>Start typing...</p>",
  });

  return (
    <RichTextEditor editor={editor}>
      <RichTextEditor.Toolbar sticky>
        <RichTextEditor.ControlsGroup>
          <RichTextEditor.Bold />
          <RichTextEditor.Italic />
          <RichTextEditor.Underline />
        </RichTextEditor.ControlsGroup>
        <RichTextEditor.ControlsGroup>
          <RichTextEditor.H1 />
          <RichTextEditor.H2 />
          <RichTextEditor.H3 />
        </RichTextEditor.ControlsGroup>
        <RichTextEditor.ControlsGroup>
          <RichTextEditor.Undo />
          <RichTextEditor.Redo />
        </RichTextEditor.ControlsGroup>
      </RichTextEditor.Toolbar>
      <RichTextEditor.Content />
    </RichTextEditor>
  );
}
```

## 文档

完整 API 引用时间 [编辑cn.vercel.app/docs/编辑器](https://editorcn.vercel.app/docs/editor)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @editorcn/editor 是什么？

A 类 工具栏样式 以丰富文本编辑器为基础 提示 带有shadcn/ui设计符号。 部分 编辑器cn 编辑套房\.

### 如何安装 @editorcn/editor？

在项目目录运行 npm install @editorcn/editor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18 \|\| ^19）、react-dom（^18 \|\| ^19）、@tiptap/pm（\>=3\.0\.0 \<4）、@tiptap/core（\>=3\.0\.0 \<4）、@tiptap/react（\>=3\.0\.0 \<4）、@base-ui/react（^1\.0\.0）、@floating-ui/dom（^1\.6\.0）、@tiptap/starter-kit（\>=3\.0\.0 \<4）、@tiptap/extension-link（\>=3\.0\.0 \<4）、class-variance-authority（^0\.7\.1）、@tiptap/extension-underline（\>=3\.0\.0 \<4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @editorcn/editor 支持 TypeScript 吗？

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

### @editorcn/editor 支持 ESM 还是 CommonJS？

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

### @editorcn/editor 可以商用吗？

@editorcn/editor 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @editorcn/editor 的下载量有多少？

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

### @editorcn/editor 还在维护吗？

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