Appearance
ProForm 表单
TIP
- ProForm 是基于 Shineout Form 封装的配置驱动表单组件,通过 JSON Schema 声明式地生成完整表单,无需手写 JSX。它是 low-code 体系的核心表单引擎
js
// 设置全局回车不去触发表单校验 + 提交
import { setConfig } from "@yl_lowcode/pro-shineout";
setConfig({
enterPressTouchSubmit: false,
});基本使用
卡片表单
灵活布局
基础联动
子表单
分层表单
自定义渲染
注册自定义组件
异步选择器
API
ProFormProps 继承 Form 额外的属性描述
| 属性名 | 描述 | 类型 | 默认值 | 是否必需 |
|---|---|---|---|---|
| schema | 表单项模型 | ProFormItemProps[] | 无 | 是 |
| column | 等份布局 | 1 | 2 | 3 | 4 | 1 | 否 |
| title | 标题 | string | 无 | 否 |
| onSubmit | 提交事件 | (values: Object): void | 无 | 否 |
| okText | 提交按钮文案 | string | 提交 | 否 |
| widget | 自定义组件 | Object | 无 | 否 |
ProFormItemProps 继承 Form.Item 额外的属性描述
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| name | string | - | 字段名(必填,同时作为 Form.Field 的 name) |
| label | ReactNode | - | 字段标签 |
| type | string | Function | - | 组件类型名或自定义渲染函数(必填) |
| span | number | 24 | 占据的栅格数(24 为满行) |
| props | AllComponentProps | {} | 传递给表单组件的属性 |
| required | boolean | false | 是否必填,自动生成校验规则 |
| rules | Rule[] | - | 自定义校验规则 |
| effect | "all" | string[] | - | 依赖的字段名列表,字段变化时触发重渲染 |
| visible | (datum) => boolean | - | 根据表单值控制是否显示 |
| extendProps | (form, formListIndex) => object | - | 动态计算额外 props,接收表单实例和 FormList 行索引 |
| itemRender | (dom, form) => ReactElement | - | 自定义表单项渲染 |
| autoSearch | boolean | false | 值变化时自动触发搜索 |
| tooltip | string | - | 标签提示信息 |
| gridStyle | CSSProperties | - | 栅格容器样式 |
| defaultValue | any | - | 字段默认值 |