@djangocfg/widget-editor

中文文档
0.1.113发布于 2026/11/12MITTypeScriptES Module近 30 天下载 1.5万

TipTap editors: a markdown field with mentions and chips, and a Notion-style block editor with slash commands, tables and embedded blocks

原始使用文档
文档目录4 节
  1. Install
  2. There is no root barrel worth importing
  3. The map block is a real dependency
  4. Verify

@djangocfg/widget-editor

Two TipTap editors and the pieces both are built from.

SubpathWhatOwn docs
./markdownMarkdownEditor — a markdown field with mentions, URL and file-path chipssrc/markdown/README.md
./notionNotionEditor — a block editor: slash menu, tables, tasks, code, bookmarks, mapssrc/notion/README.md, @docs/
./blocksThe zod schemas for the embeddable block payloads—
./link-previewLinkPreviewCard and the ResolveLinkPreview seam—
./chipsUrlChip, FilePathChip — the same pills outside an editorsrc/chips/README.md
./tiptapuseNodeAttrs and the node-view helpers—

Install

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

zod is a peer: the block schemas validate payloads a host also validates, and two copies would reject each other's instances.

There is no root barrel worth importing

The root exports a type and nothing else, on purpose. TipTap is sixteen packages, and the two editors share no consumer — an app wanting the markdown field must not resolve the Notion editor's tables, drag handle and syntax highlighter behind it. Import a subpath.

The map block is a real dependency

NotionEditor's mapBlock renders @djangocfg/widget-map, so the editor depends on the map widget rather than the other way round. It arrives through the map's lazy entry, so MapLibre still loads only when a map block mounts.

Verify

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

版本与发布记录

@djangocfg/widget-editor 共发布 97 个版本,首次发布于 2026/09/09;过去 12 个月发布了 97 个版本。

版本发布日期距今
0.1.113latest2026/11/12今天
0.1.1112026/11/12今天
0.1.1102026/11/11今天
0.1.1092026/11/111 天前
0.1.1082026/11/111 天前
0.1.1062026/11/111 天前

关于 @djangocfg/widget-editor 的常见问题

@djangocfg/widget-editor 是什么?

TipTap editors: a markdown field with mentions and chips, and a Notion-style block editor with slash commands, tables and embedded blocks

如何安装 @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 和提交记录判断。