npm install --save https://github.com/SunXingZ/easyform.git or yarn add https://github.com/SunXingZ/easyform.git
参数 | 说明 | 类型 | 默认值 | 示例 |
---|---|---|---|---|
name | Form.Item的name 属性 |
string | - | - |
label | Form.Item的label 属性 |
ReactNode | - | - |
preview | 表单预览模式 | boolean | ReactNode | ({ value, options, elementType }) => ReactNode | - | - |
elementType | 表单类型 | string | - | 'input' |
elementProps | 作用于表单元素的props,例如:disabled ,placeholder 等 |
object | {} | - |
itemProps | 作用于Form.item的props,例如:rules ,extra 等 |
object | {} | { rules: [ { required: true, message: '请输入' } ] } |
options | 当elementType为select ,radio ,checkbox 等类型时需要配置 |
string | array | object,为string时作为接口地址。为array时作为options选项。为object时object.url作为接口地址。object.dataKey为数据在response中的名称,例如:response = { status: 200, data: [] } 则dataKey应配置为'data',默认'data'。 object.labelKey指定option.label取值,默认'name'。object.valueKey指定option.value如何取值,默认'id'。 | [] | 详见:example下App.js中的示例 |
rightExtra | 表单右侧显示的信息 | ReactNode | - | 获取验证码 |
description | 表单底部显示的信息,位于Form.item的extra 下 |
ReactNode | - | 一段描述信息 |
shouldUpdate | 此属性会覆盖Form.Item的shouldUpdate ,作为控制表单显示隐藏的配置。 |
object | {} | { age: 18, type: [1, 2] } 表示age 字段值为18且type 字段值为1或2时表单会显示,否则隐藏。 |
MIT © SunXingZ