# @djangocfg/widget-editor 中文文档

规范地址：https://npmcn.com/package/%40djangocfg/widget-editor/

版本：0\.1\.113
npm 元数据更新时间：2026-11-12T12:32:39.300Z
中文译文更新时间：2026-11-12T12:12:04.601Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40djangocfg/widget-editor
原文对照：https://npmcn.com/package/%40djangocfg/widget-editor/?lang=original
项目主页：https://djangocfg.com/
源码仓库：https://github.com/markolofsen/django-cfg

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

- 包体积（解压后）：289 kB，57 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：22 个
- peer 依赖：zod ^4\.3\.6，react ^19\.0\.0，react-dom ^19\.0\.0，lucide-react ^1\.68\.0，@djangocfg/ui-core ^2\.1\.655
- 首次发布：2026-09-09T08:12:55.171Z
- 最新版本发布：2026-11-12T12:32:38.992Z
- 近 30 天下载量：14586（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：97（近 12 个月 97 个）

## 中文简介

TipTap 编辑器: 包含引用和芯片的标记下字段, 以及带有斜线命令、 表格和嵌入式块的 Notion 风格块编辑器

## 安装

```sh
npm install @djangocfg/widget-editor
```

也可以使用：`pnpm add @djangocfg/widget-editor`、`yarn add @djangocfg/widget-editor`、`bun add @djangocfg/widget-editor`

## README

# @djangocfg/widget-编辑器

两个TipTap编辑器和两部作品都是由来而来.

| 子路径 | 什麽 | 拥有文件 |
| --- | --- | --- |
| `./markdown` | `MarkdownEditor` – 有引用、 URL 和文件路径芯片的标记域 | [`src/markdown/README.md`](https://npmcn.com/package/%40djangocfg/widget-editor/src/markdown/README.md) |
| `./notion` | `NotionEditor` ——块编辑器:斜线菜单,表格,任务,代码,书签,地图 | [`src/notion/README.md`](https://npmcn.com/package/%40djangocfg/widget-editor/src/notion/README.md), (中文(简体) ), [`@docs/`](https://npmcn.com/package/%40djangocfg/widget-editor/src/notion/@docs/) |
| `./blocks` | 嵌入式弹道有效载荷的Zod计划 | —— 说 |
| `./link-preview` | `LinkPreviewCard` 编辑 `ResolveLinkPreview` 连接 | —— 说 |
| `./chips` | `UrlChip`, (中文(简体) ), `FilePathChip` - 编辑外的同一种药 | [`src/chips/README.md`](https://npmcn.com/package/%40djangocfg/widget-editor/src/chips/README.md) |
| `./tiptap` | `useNodeAttrs` 和节点视图助手 | —— 说 |

## 安装

```bash
pnpm add @djangocfg/widget-editor @djangocfg/ui-core zod
```

`zod` 是同位素:区块计划验证一个主机也验证的有效载荷,以及 两份会拒绝对方的例子.

## 没有根管值得导入

根会故意输出出一种类型,而别的东西。 TipTap 十六岁了 软件包,两位编辑没有共享消费者——一个需要减记的应用程序 字段不能解决逗号编辑器的表格,拖动手柄和语法 后显相. **导入子路径 .**

## 地图块是一个真正的依赖性

`NotionEditor`是因为 `mapBlock` 调制 `@djangocfg/widget-map`所以编辑 取决于地图部件,而不是相反。 它通过 地图的懒惰性输入,所以MapLibre仍然只在地图块上架时才加载.

## 校验

```bash
pnpm --filter @djangocfg/widget-editor check-types test
```

## 常见问题

### @djangocfg/widget-editor 是什么？

TipTap 编辑器: 包含引用和芯片的标记下字段, 以及带有斜线命令、 表格和嵌入式块的 Notion 风格块编辑器

### 如何安装 @djangocfg/widget-editor？

在项目目录运行 npm install @djangocfg/widget-editor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.3\.6）、react（^19\.0\.0）、react-dom（^19\.0\.0）、lucide-react（^1\.68\.0）、@djangocfg/ui-core（^2\.1\.655）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @djangocfg/widget-editor 支持 TypeScript 吗？

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

### @djangocfg/widget-editor 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @djangocfg/widget-editor 可以商用吗？

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

### @djangocfg/widget-editor 的下载量有多少？

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

### @djangocfg/widget-editor 还在维护吗？

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