@coding-flow/flow-pc-form
v0.0.4
Published
flow-engine pc form engine
Downloads
377
Readme
@coding-flow/flow-pc-form
Flow Engine PC 端表单组件库,提供表单设计器、表单渲染等功能。
简介
flow-pc-form 是 Flow Engine PC 端的表单相关组件库,提供:
- 表单设计器(可视化表单设计)
- 表单渲染器(动态表单渲染)
- 表单字段组件
- 表单验证规则
- 表单权限控制
依赖关系
- 依赖:
@coding-flow/flow-core,@coding-flow/flow-types
Setup
安装依赖:
pnpm install开发
构建组件库:
pnpm run build监听模式构建:
pnpm run dev核心功能
表单设计器
可视化表单设计器,支持:
- 拖拽添加字段
- 字段属性配置
- 字段排序
- 表单预览
- 表单 schema 导出
import { FormDesigner } from '@coding-flow/flow-pc-form';
<FormDesigner
schema={formSchema}
onChange={handleSchemaChange}
onPreview={handlePreview}
/>表单渲染器
根据表单 schema 动态渲染表单:
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使用示例
表单设计器
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}
/>
);
};表单渲染器
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 - Rslib 特性和 API
- Flow Engine Docs - 完整文档
- CLAUDE.md - 开发指南
