JakHuang/form-generator

JSON表单参数对照表

JakHuang opened this issue · 3 comments

本文对项目中的json表单配置做一些参数说明。

内置布局及其属性

目前有的布局方式:

  • colFormItem:生成el-col包裹的组件布局
  • rowFormItem:生成一个空的el-row

colFormItem

属性 可选性 说明 默认值
__config__.layout 可选 组件使用的布局方式 colFormItem
__vModel__ 必选 表单字段的属性名,可自定义 系统自增
__config__.defaultValue 可选 默认值;与__vModel__对应使用,可指定表单字段的默认值;可用于表单数据回填
__config__.tag 必选 组件名称
__config__.changeTag 必选 是否允许显示切换组件面板
__config__.tagIcon 必选 组件svg图标名称
__config__.label 必选 表单标题
__config__.showLabel 必选 是否显示表单标题
__config__.labelWidth 必选 表单标题区域宽度(px)
__config__.required 必选 是否要求表单校验
__config__.regList 可选 表单正则校验;赋值为数组时,显示配置项
__config__.span 必选 24栅格系统,表示组件的栅格数
__config__.children 可选 子组件,目前仅保留字段,实际并没有做解析
__config__.document 可选 组件说明文档地址
__slot__ 可选 对应,需在工程文件夹src\components\render\slots中添加与__config__.tag同名的.js文件解析该配置。
其余属性 可选 根据不同组件的属性灵活配置。属于本组件的属性写在一级(与__config__同级);若需自定义属性以达到控制右侧面板或其他目的的,可在__config__中自定义属性(如:__config__.showLabel

rowFormItem

属性 可选性 说明 默认值
__config__.layout 可选 组件使用的布局方式 colFormItem
__config__.componentName 必选 组件名,无需操作 系统自增
__config__.tagIcon 必选 组件svg图标名称
__config__.layoutTree 可选 是否显示布局树
__config__.children 必选 子组件,组件嵌套的关键 []
__config__.document 可选 组件说明文档地址
其余属性 可选 可参照 el-row属性表按需配置

good job!

从接口取出数据渲染失败