# @coding-flow/flow-pc-form 中文文档

规范地址：https://npmcn.com/package/%40coding-flow/flow-pc-form/

版本：0\.2\.17
npm 元数据更新时间：2026-11-07T09:54:21.754Z
中文译文更新时间：2026-11-10T09:19:42.422Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40coding-flow/flow-pc-form
原文对照：https://npmcn.com/package/%40coding-flow/flow-pc-form/?lang=original
项目主页：https://github.com/codingapi/flow-frontend
源码仓库：https://github.com/codingapi/flow-frontend

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

- 包体积（解压后）：32.2 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：react \>=18，react-dom \>=18
- 首次发布：2026-03-17T06:39:15.459Z
- 最新版本发布：2026-11-07T09:54:21.568Z
- 近 30 天下载量：1883（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：82（近 12 个月 82 个）

## 中文简介

流程引擎 pc 形式引擎

## 安装

```sh
npm install @coding-flow/flow-pc-form
```

也可以使用：`pnpm add @coding-flow/flow-pc-form`、`yarn add @coding-flow/flow-pc-form`、`bun add @coding-flow/flow-pc-form`

## README

# @coding-flow/flow-pc-form

Flow Engine PC 端表单组件库，提供表单设计器、表单渲染等功能。

## 简介

`flow-pc-form` 是 Flow Engine PC 端的表单相关组件库，提供：

-   表单设计器（可视化表单设计）
-   表单渲染器（动态表单渲染）
-   表单字段组件
-   表单验证规则
-   表单权限控制

### 依赖关系

-   **依赖**: `@coding-flow/flow-core`, `@coding-flow/flow-types`

## Setup

安装依赖:

```bash
pnpm install
```

## 开发

构建组件库:

```bash
pnpm run build
```

监听模式构建:

```bash
pnpm run dev
```

## 核心功能

### 表单设计器

可视化表单设计器，支持：

-   拖拽添加字段
-   字段属性配置
-   字段排序
-   表单预览
-   表单 schema 导出

```typescript
import { FormDesigner } from '@coding-flow/flow-pc-form';

<FormDesigner
  schema={formSchema}
  onChange={handleSchemaChange}
  onPreview={handlePreview}
/>
```

### 表单渲染器

根据表单 schema 动态渲染表单：

```typescript
import { FormRenderer } from '@coding-flow/flow-pc-form';

<FormRenderer
  schema={formSchema}
  values={formValues}
  onChange={handleValuesChange}
  permissions={fieldPermissions}
/>
```

### 表单字段

支持多种字段类型：

-   单行文本
-   多行文本
-   数字
-   日期
-   下拉选择
-   单选/多选
-   人员选择
-   部门选择
-   附件上传

### 表单验证

内置验证规则：

-   必填验证
-   长度限制
-   格式验证（邮箱、手机号等）
-   自定义验证规则

### 表单权限

字段级别权限控制：

-   可编辑
-   只读
-   隐藏
-   必填

## 模块结构

```
flow-pc-form/
├── src/
│   ├── designer/       # 表单设计器
│   ├── renderer/       # 表单渲染器
│   ├── fields/         # 表单字段组件
│   ├── validator/      # 表单验证
│   ├── schema/         # 表单 schema 定义
│   └── index.ts        # 统一导出
└── README.md
```

## 使用示例

### 表单设计器

```typescript
import { FormDesigner } from '@coding-flow/flow-pc-form';
import type { FlowForm } from '@coding-flow/flow-types';

const MyFormDesigner = () => {
  const [schema, setSchema] = useState<FlowForm>({ ... });

  return (
    <FormDesigner
      schema={schema}
      onChange={setSchema}
      onSave={handleSave}
    />
  );
};
```

### 表单渲染器

```typescript
import { FormRenderer } from '@coding-flow/flow-pc-form';
import type { FlowForm, FormFieldPermission } from '@coding-flow/flow-types';

const MyFormRenderer = () => {
  const [values, setValues] = useState({});

  return (
    <FormRenderer
      schema={formSchema}
      values={values}
      onChange={setValues}
      permissions={permissions}
    />
  );
};
```

## Learn more

-   [Rslib documentation](https://lib.rsbuild.io/) - Rslib 特性和 API
-   [Flow Engine Docs](https://github.com/codingapi/flow-engine) - 完整文档
-   [CLAUDE.md](https://npmcn.com/CLAUDE.md) - 开发指南

## 常见问题

### @coding-flow/flow-pc-form 是什么？

流程引擎 pc 形式引擎

### 如何安装 @coding-flow/flow-pc-form？

在项目目录运行 npm install @coding-flow/flow-pc-form，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）、react-dom（\>=18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @coding-flow/flow-pc-form 支持 TypeScript 吗？

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

### @coding-flow/flow-pc-form 支持 ESM 还是 CommonJS？

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

### @coding-flow/flow-pc-form 可以商用吗？

@coding-flow/flow-pc-form 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @coding-flow/flow-pc-form 的下载量有多少？

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

### @coding-flow/flow-pc-form 还在维护吗？

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