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

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

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

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

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

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

- 包体积（解压后）：2.2 MB，128 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：14 个
- 首次发布：2021-02-24T14:56:23.733Z
- 最新版本发布：2026-11-06T12:24:19.897Z
- 近 30 天下载量：106272（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 20 个）

## 中文简介

查看窗体 - 由 bpmn.io 供电

## 安装

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

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

## README

# @bpmn-io/form-js-查看器

此库导出一个表单查看器, 用于查看和提交表单 。 使用 [我们的编辑](https://npmcn.com/package/%40bpmn-io/form-js-editor) 来创建和编辑表格.

## 安装

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

## 使用量

```javascript
import { Form } from '@bpmn-io/form-js-viewer';

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

const data = {
  creditor: 'John Doe Company',
};

const form = new Form({
  container: document.querySelector('#form'),
});

await form.importSchema(schema, data);

// add event listeners
form.on('submit', (event) => {
  console.log('Form <submit>', event);
});

// provide a priority to event listeners
form.on('changed', 500, (event) => {
  console.log('Form <changed>', event);
});
```

### 自定义文档预览请求

如果你使用 `documentPreview` 字段并需要自定义文件下载/审查的认证, 您可以提供 `documentEndpointBuilder` 通过依赖性注射提供服务.

```javascript
import { Form } from '@bpmn-io/form-js-viewer';

const DocumentPreviewRequestModule = {
  documentEndpointBuilder: [
    'value',
    {
      buildUrl: (document) => document.endpoint,
      buildRequestInit: (document) => ({
        headers: {
          'x-document-id': document.documentId,
        },
        credentials: 'include',
      }),
    },
  ],
};

const form = new Form({
  container: document.querySelector('#form'),
  additionalModules: [DocumentPreviewRequestModule],
});
```

`buildRequestInit` 是可选的,用于 [配置获取请求](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit)。如果省略,文档请求使用默认 `fetch(url)` 行为.

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

## 样式

适当的造型包括: `form-js.css` 所用样式表和字体 :

```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 href="https://unpkg.com/@bpmn-io/form-js/dist/assets/form-js.css" rel="stylesheet" />
```

## API 密码

### `Form`

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

```javascript
import { Form } from '@bpmn-io/form-js-viewer';

const form = new Form({
  container: document.querySelector('#form'),
});
```

### `Form#importSchema(schema: Schema, data?: Data) => Promise<Result, Error>`

显示通过窗体图和可选数据表示的窗体.

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

### `Form#submit() => { data: Data, errors: Errors }`

按程序提交表格 .

```javascript
const { data, errors } = form.submit();

if (Object.keys(errors).length) {
  console.error('Form submitted with errors', errors);
}
```

### `Form#validate() => Errors`

程序验证一个形式 .

```javascript
const errors = form.validate();

if (Object.keys(errors).length) {
  console.error('Form has errors', errors);
}
```

### `Form#reset() => void`

程序重设表格 .

### `Form#setProperty(key, value) => void`

设置窗体属性, 例如 `readOnly`。 。 。 .

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

将表单附加到父节点上.

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

将窗体从父节点中分离出 .

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

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

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

从文档中删除窗体.

## 活动

### `changed :: { data, errors }`

每次有变形状态时就被炒了.

### `submit :: { data, errors }`

在提交表格时被开除.

### `import.done :: { error, warnings }`

当一个计划完成导入时, 无论它成功还是失败, 都被解雇 .

### 活动布局

-   `form.layoutCleared`
-   `form.layoutCalculated :: { rows }`

### 生命周期事件

-   `detach`
-   `attach`
-   `form.init`
-   `form.clear`
-   `form.destroy`
-   `diagram.clear`
-   `diagram.destroy`

### 福特菲尔德事件

-   `formField.add :: { formField }`
-   `formField.remove :: { formField }`
-   `formField.focus :: { formField }`
-   `formField.blur :: { formField }`
-   `formField.search :: { formField, value }`

## 许可证

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

## 常见问题

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

查看窗体 - 由 bpmn\.io 供电

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

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

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

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

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

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

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

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

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

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

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

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