# @bpmn-io/form-js-editor 中文文档

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

版本：2\.2\.0
npm 元数据更新时间：2026-11-06T12:23:42.469Z
中文译文更新时间：2026-11-08T13:06:59.210Z
软件包许可：SEE LICENSE IN LICENSE

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

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

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

- 包体积（解压后）：2.6 MB，172 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：10 个
- 首次发布：2021-03-19T16:12:42.071Z
- 最新版本发布：2026-11-06T12:23:42.262Z
- 近 30 天下载量：61249（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：142（近 12 个月 23 个）

## 中文简介

编辑窗体 - 由 bpmn.io 供电

## 安装

```sh
npm install @bpmn-io/form-js-editor
```

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

## README

# @bpmn-io/form-js-编辑器

一个编辑器,用于创建可随显示的窗体 [窗体- js 查看器](https://npmcn.com/package/%40bpmn-io/form-js-viewer)。 。 。 .

## 安装

```
npm install @bpmn-io/form-js-editor
```

## 使用量

```javascript
import { FormEditor } from '@bpmn-io/form-js-editor';

const schema = {
  type: 'default',
  components: [
    {
      key: 'creditor',
      label: 'Creditor',
      type: 'textfield',
      validate: {
        required: true,
      },
    },
  ],
};

const formEditor = new FormEditor({
  container: document.querySelector('#form-editor'),
});

await formEditor.importSchema(schema);
```

检查出来 [一个完整的例子](https://github.com/bpmn-io/form-js-examples)。 。 。 .

## 样式

适当的样式包括必要的样式表和使用的字体:

```html
<link
  href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,400;0,600;1,400&display=swap"
  rel="stylesheet" />

<link rel="stylesheet" href="https://unpkg.com/@bpmn-io/form-js@0.10.0/dist/assets/form-js.css" />
<link rel="stylesheet" href="https://unpkg.com/@bpmn-io/form-js@0.10.0/dist/assets/form-js-editor.css" />
```

## API 密码

### `FormEditor`

创建带有选项的新窗体编辑器 `{ container?: HTMLElement }`。 。 。 .

```javascript
import { FormEditor } from '@bpmn-io/form-js-editor';

const formEditor = new FormEditor({
  container: document.querySelector('#form-editor'),
});
```

### `FormEditor#importSchema(schema: Schema) => Promise<Result, Error>`

显示和编辑通过窗体图示表示的窗体.

```javascript
try {
  await formEditor.importSchema(schema);
} catch (err) {
  console.log('importing form failed', err);
}
```

### `FormEditor#saveSchema() => Schema`

导出表单图案 .

```javascript
const schema = formEditor.saveSchema(schema);

console.log('exported schema', schema);
```

### `FormEditor#attachTo(parentNode: HTMLElement) => void`

将窗体编辑器附加到父节点.

### `FormEditor#detach() => void`

将窗体编辑器从父节点中分离出来 .

### `FormEditor#on(event, fn) => void`

订阅 [事件](https://npmcn.com/package/%40bpmn-io/form-js-editor/#readme-events)。 。 。 .

### `FormEditor#destroy() => void`

从文档编辑器中删除窗体.

## 活动

### `selection.changed :: { selection }`

### 属性面板事件

-   `propertiesPanel.focusin`
-   `propertiesPanel.focusout`
-   `propertiesPanel.showEntry :: { id }`
-   `propertiesPanel.updated :: { formField }`

### 形成生命周期事件

-   `detach`
-   `attach`
-   `rendered`
-   `form.init`
-   `form.clear`
-   `form.destroy`
-   `diagram.clear`
-   `diagram.destroy`
-   `dragula.created`
-   `dragula.destroyed`
-   `editorActions.init :: { editorActions }`

### 拖动事件

-   `drag.start :: { element, source }`
-   `drag.end :: { element }`
-   `drag.drop :: { element, target, source, sibling }`
-   `drag.hover :: { element, container, source }`
-   `drag.out :: { element, container, source }`
-   `drag.cancel :: { element, container, source }`

### 外地活动形式

-   `formField.add :: { formField }`
-   `formField.remove :: { formField }`
-   `formField.updateId :: { formField, newId }`

## 许可证

B. 《公约》条款之下的使用 [bpmn.io 许可证](http://bpmn.io/license)。 。 。 .

## 常见问题

### @bpmn-io/form-js-editor 是什么？

编辑窗体 - 由 bpmn\.io 供电

### 如何安装 @bpmn-io/form-js-editor？

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

### @bpmn-io/form-js-editor 支持 TypeScript 吗？

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

### @bpmn-io/form-js-editor 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bpmn-io/form-js-editor 可以商用吗？

@bpmn-io/form-js-editor 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @bpmn-io/form-js-editor 的下载量有多少？

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

### @bpmn-io/form-js-editor 还在维护吗？

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