@bpmn-io/form-js

中文文档
2.2.0发布于 2026/11/06SEE LICENSE IN LICENSETypeScriptESM + CJS近 30 天下载 5.7万

查看和编辑表单 - 由 bpmn.io 提供动力

中文使用文档
文档目录7 节
  1. 使用量
  2. 显示窗体
  3. 创建和编辑窗体
  4. 用输入和输出数据创建和模拟窗体
  5. 从窗体获取计划变量
  6. 资源
  7. 许可证

@bpmn-io/form-js (英语)

CI

视图, (中文(简体) ), 编辑 财务报告和审定财务报表 模拟 基于JSON的表格.

使用量

此库输出 a 窗体查看器, (中文(简体) ), 编辑器 财务报告和审定财务报表 游乐场。 。 。 .

显示窗体

以 窗体计划 和现有数据:

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

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);

form.on('submit', (event) => {
  console.log(event.data, event.errors);
});

见 查看器文档 详细情况.

创建和编辑窗体

创建新窗体或编辑出局窗体 :

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

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

await formEditor.importSchema(schema);

见 编辑文档 详细情况.

用输入和输出数据创建和模拟窗体

以输入和输出数据创建和模拟窗体 :

import { FormPlayground } from '@bpmn-io/form-js';

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

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

const formPlayground = new FormPlayground({
  container: document.querySelector('#form-playground'),
  schema,
  data,
});

见 游乐场文档 详细情况.

从窗体获取计划变量

使用 getSchemaVariables 用于检索在表单图中定义的变量。 这有助于收集以某种形式消耗和生成的数据.

import { getSchemaVariables } from '@bpmn-io/form-js';

const variables = getSchemaVariables(schema);

console.log('Schema variables', variables);

还可以区分投入变量和产出变量:

import { getSchemaVariables } from '@bpmn-io/form-js';

const outputVariables = getSchemaVariables(schema, { inputs: false });
const inputVariables = getSchemaVariables(schema, { outputs: false });

资源

许可证

B. 《公约》条款之下的使用 bpmn.io 许可证。 。 。 .

版本与发布记录

@bpmn-io/form-js 共发布 146 个版本,首次发布于 2021/02/24;过去 12 个月发布了 23 个版本。

版本发布日期距今
2.2.0latest2026/11/062 天前
2.1.12026/10/011 个月前
2.1.02026/09/281 个月前
2.0.22026/09/281 个月前
2.0.12026/09/251 个月前
2.0.02026/09/181 个月前

其他发布通道:backports → 1.15.5,alpha → 2.0.0-alpha.0。

关于 @bpmn-io/form-js 的常见问题

@bpmn-io/form-js 是什么?

查看和编辑表单 - 由 bpmn.io 提供动力

如何安装 @bpmn-io/form-js?

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

@bpmn-io/form-js 支持 TypeScript 吗?

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

@bpmn-io/form-js 支持 ESM 还是 CommonJS?

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

@bpmn-io/form-js 可以商用吗?

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

@bpmn-io/form-js 的下载量有多少?

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

@bpmn-io/form-js 还在维护吗?

最新版本 2.2.0 发布于 2026/11/06(2 天前);至今共发布 146 个版本,其中过去 12 个月发布了 23 个;首次发布于 2021/02/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。