# @djangocfg/widget-diagram 中文文档

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

版本：0\.1\.27
npm 元数据更新时间：2026-11-11T03:52:49.586Z
中文译文更新时间：2026-11-12T12:17:34.574Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：118 kB，49 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^19\.0\.0，react-dom ^19\.0\.0，lucide-react ^1\.68\.0，@djangocfg/ui-core ^2\.1\.648
- 首次发布：2026-09-09T08:12:54.031Z
- 最新版本发布：2026-11-11T03:52:49.427Z
- 近 30 天下载量：4252（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 24 个）

## 中文简介

美人鱼图:写出源代码的打字器和绘制源代码的全平板渲染器

## 安装

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

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

## README

# @djangocfg/ widget-diagram (英语)

人造人造人造人造人造人图,既分出一半:输入了WRITE源代码,又输入了A 完全 Parser 渲染器 DRAWS 它。 支持构建者覆盖的图表类型(`FlowDiagram`, (中文(简体) ), `SequenceDiagram`, (中文(简体) ), `JourneyDiagram`再加上其他的美人鱼, 班级、州级、ER级、派级、心智图级,......) `chart` 道具 (英语). 点击全屏 通过浮动工具栏.

## 安装

```bash
pnpm add @djangocfg/widget-diagram @djangocfg/ui-core
```

## 哪个渲染器

`@djangocfg/widget-media/diagram` 是另一个,它不是重复.

|  | `widget-diagram` | `widget-media/diagram` |
| --- | --- | --- |
| 解析器 | `mermaid`, ~84 MB 无包装 | `beautiful-mermaid`, ~2 MB 键 |
| 封面 | 一切美人鱼解剖 | 流程图、序列、状态、类别、ER-来源 |
| 对于 | 一个工作就是图的表面 | 聊天记录, 大多数信件没有 |

不要将两者导入到一个应用程序中.

## 没有渲染器的构建器

```ts
import { FlowDiagram } from '@djangocfg/widget-diagram/builders';
```

这个 `./builders` 子路径没有静态边缘到解析器,所以服务器通过, 测试或CLI可以不溶解渲染器而写出图源. `src/entries.test.ts` 拿着这个.

## 校验

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

```tsx
import Mermaid from '@djangocfg/widget-diagram';

<Mermaid chart={`
flowchart LR
  A[Client] --> B[API] --> C[(DB)]
`} />
```

构建器 API :

```tsx
import Mermaid, { FlowDiagram } from '@djangocfg/widget-diagram';

const chart = new FlowDiagram({ direction: 'LR' })
  .node('a', 'Client')
  .node('b', 'API')
  .edge('a', 'b')
  .build();

<Mermaid chart={chart} />
```

## 道具

| Prop | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `chart` | `string` | —— 说 | 美人鱼源. |
| `isCompact` | `boolean` | `false` | 对嵌入式上下文进行更紧的粘贴. |
| `fullscreen` | `boolean` | `true` | 通过浮动工具栏单击至全屏. |
| `scrollIsolation` | `boolean` | `false` | 盘旋时锁定页面轮. 默认关闭——美人鱼SVG不滚动,覆被只是偷取了轮子事件. |
| `debounceMs` | `number` | `300` | 于 `chart` 变化。 静态图较低,流出时较高. |
| `className` | `string` | —— 说 | —— 说 |

## 页:1

-   **~ 800KB 捆绑** ——进入点已经 `lazy()`\- 包着一个 `Suspense` 旋转器,所以成本只有在一个图实际挂起时才支付.
-   他们从 `useThemePalette` 编号 : `useStylePresets` 编号 : `useBoxColors` (与构建者一起导出) — 美人鱼颜色遵循活性应用主题; 不使用硬码十六进制.

* * *

改编自jalcoui(麻省理工学院).

## 常见问题

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

美人鱼图:写出源代码的打字器和绘制源代码的全平板渲染器

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

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

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

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

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

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

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

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

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

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

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

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