# @bpmn-io/diagram-js-ui 中文文档

规范地址：https://npmcn.com/package/%40bpmn-io/diagram-js-ui/

版本：0\.2\.4
npm 元数据更新时间：2026-07-08T15:54:01.836Z
中文译文更新时间：2026-11-08T13:04:55.459Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bpmn-io/diagram-js-ui
原文对照：https://npmcn.com/package/%40bpmn-io/diagram-js-ui/?lang=original
项目主页：https://github.com/bpmn-io/diagram-js-ui#readme
源码仓库：https://github.com/bpmn-io/diagram-js-ui

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

- 包体积（解压后）：4.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-10-26T07:18:40.194Z
- 最新版本发布：2026-06-03T19:30:19.678Z
- 近 30 天下载量：1352241（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 1 个）

## 中文简介

[![CI](https://github.com/bpmn-io/diagram-js-ui/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/diagram-js-ui/actions/workflows/CI.yml)

## 安装

```sh
npm install @bpmn-io/diagram-js-ui
```

也可以使用：`pnpm add @bpmn-io/diagram-js-ui`、`yarn add @bpmn-io/diagram-js-ui`、`bun add @bpmn-io/diagram-js-ui`

## README

# 图表-js-ui

[![CI](https://github.com/bpmn-io/diagram-js-ui/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/diagram-js-ui/actions/workflows/CI.yml)

一个包裹周围 [`htm/preact`](https://github.com/developit/htm#usage) 显示用于在 [图表-js](https://github.com/bpmn-io/diagram-js) 和延长.

## 使用量

此模块可通过 `diagram-js/lib/ui`。用它来创建和挂载您的 [预录](https://preactjs.com/) 部件,并通过 [`htm` 工具](https://github.com/developit/htm)。 。 。 .

```javascript
// MyService.js
import { render, html } from 'diagram-js/lib/ui';
import MyCounter from './MyCounter';

export default function MyService() {
  const parentElement = document.createElement('div');

  render(html`<${MyCounter} />`, parentElement);
}
```

```javascript
// MyCounter.js
import { useState, html } from 'diagram-js/lib/ui';

export default function MyCounter(props) {
  const counter = useState(0);

  return html`
    <div>Counter: ${counter}</div>
  `;
}
```

## 构建和运行

```sh
# install all dependencies
npm install

# lint and build the library
npm run all
```

## 许可证

麻省理工学院

## 常见问题

### 如何安装 @bpmn-io/diagram-js-ui？

在项目目录运行 npm install @bpmn-io/diagram-js-ui，或使用 pnpm add / yarn add / bun add。

### @bpmn-io/diagram-js-ui 支持 TypeScript 吗？

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

### @bpmn-io/diagram-js-ui 支持 ESM 还是 CommonJS？

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

### @bpmn-io/diagram-js-ui 可以商用吗？

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

### @bpmn-io/diagram-js-ui 的下载量有多少？

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

### @bpmn-io/diagram-js-ui 还在维护吗？

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

