# @eraserlabs/diagrams 中文文档

规范地址：https://npmcn.com/package/%40eraserlabs/diagrams/

版本：0\.5\.2
npm 元数据更新时间：2026-11-11T18:26:23.062Z
中文译文更新时间：2026-11-13T20:26:48.474Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40eraserlabs/diagrams
原文对照：https://npmcn.com/package/%40eraserlabs/diagrams/?lang=original
项目主页：https://github.com/eraserlabs/eraser-diagrams
源码仓库：https://github.com/eraserlabs/eraser-diagrams

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

- 包体积（解压后）：544 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.23\.4 \|\| ^24\.22\.1 \|\| \>=26\.12\.1
- 运行依赖：7 个
- 首次发布：2026-08-19T03:42:03.367Z
- 最新版本发布：2026-11-11T18:26:22.578Z
- 近 30 天下载量：10289（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

不洁导体:拥有Chrimium,网络,字体生命周期和Eraser模板库.

## 安装

```sh
npm install @eraserlabs/diagrams
```

也可以使用：`pnpm add @eraserlabs/diagrams`、`yarn add @eraserlabs/diagrams`、`bun add @eraserlabs/diagrams`

## README

# @ eraserlabs/ 图表

## 导言

`@eraserlabs/diagrams` 是输油管的电池输入点 拥有所有不干净的东西 它驱动铬(通过 `playwright-core`),分级并注入字体,取取图标,并运送存货 Eraser 组件库,接线 `@eraserlabs/resolve` 财务报告和审定财务报表 `@eraserlabs/render` 变成一个将 JSON 图表转换成 PNG 、 测量 JSON 或 独立 HTML 的单调.

纯子活在下面:合同在 `@eraserlabs/protocol`中,验证和解析 `@eraserlabs/resolve`,页内测量和布局 `@eraserlabs/render` 财务报告和审定财务报表 `@eraserlabs/layout`。当您需要没有浏览器的管道时,直接使用这些;当您需要图片时,使用此软件包.

## 使用量

```ts
import { createRenderer } from '@eraserlabs/diagrams';

const renderer = await createRenderer({ chromiumPath: '/path/to/chromium' });

const result = await renderer.render({
  entities: [{ tag: 'Textbox', id: 't1', x: 40, y: 40, text: 'Hello' }],
  connections: [],
  outputs: { png: true, json: true },
});

if (result.ok) {
  await writeFile('diagram.png', result.png);
}

await renderer.close();
```

Chromium为呼叫者拥有:通过本地 `chromiumPath`,或一个 `browser` 呼叫器管理和远程浏览器的提供者(`chromium.connectOverCDP(...)`) (中文(简体) ). 提供商拥有其浏览器的旗帜——如果你使用 `url` 从本地主机或私人网络服务字体面孔, 启动 `--disable-features=LocalNetworkAccessChecks,BlockInsecurePrivateNetworkRequests`,因为没有源代码的渲染页面在其他方面有其字体被Chrimium的"本地网络访问检查"(该检查)无声地阻断 `chromiumPath` 路径为您应用这些旗帜。 其它一切默认为库存: Eraser 组件库、销售字体(Shantell Sans、Inter、JetBrains Mono——全部为SIL OFL 1.1,下) `fonts/`),和 Eraser 托管的图标目录(需要网络访问; 供应) `iconLoader` 用于离线或自定义图标.

设定 `theme: 'dark'` 打开 `createRenderer` 用于默认演示,或用于个人 `renderer.render({ ...document, theme: 'dark' })` 请求。 选取控制了 stream-template 颜料,文本,代码,水彩和场景背景一起. JSON 输出保留了作者的颜色 。 HTML是自成一体的,其主题根和样式与PNG相同.

PNG 输出在光线模式下具有白背景 `#171717` 在黑暗模式下。 过 `transparent: true` 改为 `createRenderer` 以保持背景透明度; 作者填充仍可看见, HTML 输出不受影响.

`renderer.validate` 运行与 `render` 不接触浏览器。 渲染向导活在还原根: `GETTING_STARTED.md` 作者和 `CUSTOMIZATION.md` 用于带入您自己的组件库、调色板和字体.

## 常见问题

### @eraserlabs/diagrams 是什么？

不洁导体:拥有Chrimium,网络,字体生命周期和Eraser模板库\.

### 如何安装 @eraserlabs/diagrams？

在项目目录运行 npm install @eraserlabs/diagrams，或使用 pnpm add / yarn add / bun add。

### @eraserlabs/diagrams 支持 TypeScript 吗？

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

### @eraserlabs/diagrams 支持 ESM 还是 CommonJS？

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

### @eraserlabs/diagrams 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.23\.4 \|\| ^24\.22\.1 \|\| \>=26\.12\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @eraserlabs/diagrams 可以商用吗？

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

### @eraserlabs/diagrams 的下载量有多少？

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

### @eraserlabs/diagrams 还在维护吗？

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