1.0.3 • Published 1 year ago
gl-react-form-render v1.0.3
gl-react-form-render
基于formily2表单引擎的通用表单渲染组件
API
| 参数名 | 说明 | 必填 | 类型 | 默认值 | 备注 | |
|---|---|---|---|---|---|---|
| title | 表单名 | false | string | '' | ||
| className | 组件外层class | false | string | '' | ||
| api | 请求schema的地址 | false | string | '/api/form-center/c' | 接口出参返参格式要求请联系作者获取 | |
| formId | 用于请求api、保存表单数据时传递参数formId | true | string | '' | 在使用api时务必填写这个参数 | |
| schema | 表单schema， 给api或者schema二选一，如果有schema就不会请求api | false | string | '' | ||
| formData | 填写的表单数据，如有则使用此数据回填在表单上，如无会根据formDataId请求表单数据 | false | string | '' | ||
| formDataId | 请求表单数据的id,新填报时可为空 | false | string | '' | ||
| formDataRequestUrl | 请求表单数据的url | false | string | '/api/form-center/data' | ||
| saveFormUrl | 保存表单数据的url | false | string | '/api/form-center/data/datas' | ||
| displayField | 在schema的字段中，选定需要展示的字段 | false | string[] | undefined | undefined | 'fieldName', fieldName为字段的name, 不传默认为undefined，表示所有schema的字段都展示 |
| readPretty | 是否阅读态 | false | boolean | false | ||
| showSubmitBtn | 表单内是否展示提交按钮 | false | boolean | false | ||
| onInit | 组件初始化时会返回组件的实例和form实例,返回格式 (instance, form) => void， instance是组件的实例，暴露了submit方法(instance.current.submit((value, formId, formDataId) => {}), 给submit传递一个方法获取form的values、存储在表单的dataId和表单Id,调用submit方法会自动触发表单校验)，form为formily创建的表单实例，具体使用方法查看formily文档 https://core.formilyjs.org/zh-CN/guide | false | function | '' |