Form
bee-form2.0.6changelogissue

API

基于 rc-form

Form

参数 说明 类型 默认值
form 经过Form.createForm包装后的组件,都带有this.props.form属性 Object -
prefixCls 类名前缀 String u-form
className 类名 String -
onSubmit 提交事件 Function -
style 样式 Object -

FormItem

参数 说明 类型 默认值
prefixCls 类名前缀 String u-form
className 类名 String -
style 样式 Object -

this.props.form 常用 api

参数 说明 类型 默认值
getFieldProps 配置受控表单元素,经过此方法包装的表单元素才可以使用this.props.form中的其它方法,此表单元素需要有onChange方法,并且onChange回调的第一个值为此表单元素当前值 - -
getFieldDecorator 类似getFieldProps - -
getFieldsValue([fieldNames: String[]]) 根据name获取多个表单元素的值 - -
getFieldValue(fieldName: String) 根据name获取单个表单元素的值 - -
getFieldInstance(fieldName: String) 根据name获取表单元素 - -
setFieldsValue(obj: Object) 根据name设置多个表单元素的值 - -
setFieldsInitialValue(obj: Object) 根据name设置多个表单元素的默认值 - -
setFields(obj: Object) 根据name设置多个表单元素的属性 - -
validateFields([fieldNames: String[]], [options: Object], callback: (errors, values) => void) 校验表单 - -
getFieldsError(names) 获取多个表单元素的错误信息 - -
getFieldError(name) 获取单个表单元素的错误信息 - -
isFieldValidating(name: String) 单个表单元素是否正在校验 - -
isFieldsValidating(names: String[]) 多个表单元素是否正在校验 - -
resetFields([names: String[]]) 重置表单 - -

getFieldProps(name, option): Object { [valuePropName], [trigger], [validateTrigger] }

参数 说明 类型 默认值
name 设置表单元素name,不可以重复 String -
option.valuePropName 设置表单元素取值的属性 String value
option.initialValue 设置默认值 any -
option.validateTrigger 设置校验时机 String onChange
option.rules 设置校验规则 Object -
option.validateFirst 当第一个校验失败时候是否继续校验下一个校验规则 boolean false

rules 常用

参考 async-validator

参数 说明 类型 默认值
enum 枚举类型 string -
len 字段长度 number -
max 最大长度 number -
message 校验文案 string -
min 最小长度 number -
pattern 正则表达式校验 RegExp -
required 是否必选 boolean false
transform 校验前转换字段值 function(value) => transformedValue:any -
type 内建校验类型,可选项 string 'string'
validator 自定义校验(注意,callback 必须被调用) function(rule, value, callback) -
whitespace 必选时,空格是否会被视为错误 boolean false