1、Form
Form |
hideRequiredMark | 隐藏所有表单项的必选标记 |
| labelAlign | label 标签的文本对齐方式：'left' | 'right'，默认为'right' | |
| labelCol | 同Form.Item里的设置，Form.Item优先级高 | |
| wrapper | ||
| layout | 表单布局：'horizontal'|'vertical'|'inline'，默认值：'horizontal' | |
| onSubmit | 数据验证成功后回调事件 | |
| colon | 配置 Form.Item 的 colon 的默认值 |
2、Form.Item
Form.Item |
label | label 标签的文本 |
| colon | 配合 label 属性使用，表示是否显示 label 后面的冒号 | |
| labelCol | object。可以通过 Form 的 labelCol 进行统一设置。当和 Form 同时设置时，以 Form.Item 为准。 | |
| wrapperCol | ||
| hasFeedback | 配合 validateStatus 属性使用，展示校验状态图标，建议只配合 Input 组件使用 | |
| help | 提示信息，如不设置，则会根据校验规则自动生成 | |
| extra | 额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 | |
| required | 是否必填，如不设置，则会根据校验规则自动生成 | |
| validateStatus | 校验状态，如不设置，则会根据校验规则自动生成，可选：'success' 'warning' 'error' 'validating' |
3、Form.create()包装后的api:
Form.create(options)(App) |
options配置 | |
| mapPropsToFields | 把父组件的属性映射到表单项上（如：把 Redux store 中的值读出），需要对返回值中的表单域数据用 Form.createFormField标记：(props) => ({ [fieldName]: FormField { value } }) |
|
| name | 设置表单域内字段 id 的前缀 | |
| validateMessages | 默认校验信息，可用于把默认错误信息改为中文等，格式与 newMessages 返回值一致：Object { [nested.path]: String } | |
| onFieldsChange | 当 Form.Item 子节点的值发生改变时触发，可以把对应的值转存到 Redux store：function(props, flelds) |
|
| onValuesChange | 任一表单域的值发生改变时的回调：function(props, changedValues, allValues) | |
Form.create(options)(App)：经 Form.create() 包装过的组件会自带 this.props.form 属性 , 下列属性为props.form里的属性 |
||
| validateFields | 校验并获取一组输入域的值与 Error，若 fieldNames 参数为空，则校验全部组件 validateFields((errors, values) => { }); //不写代表所有 validateFields(['field1', 'field2'], (errors, values) => { }); validateFields(['field1', 'field2'], options, (errors, values) => { }); options的配置： options.first：若为 true，则每一表单域的都会在碰到第一个失败了的校验规则后停止校验【boolean/false】 options.firstFields：指定表单域会在碰到第一个失败了的校验规则后停止校验【String[]/[]】 options.force：对已经校验过的表单域，在 validateTrigger 再次被触发时是否再次校验【boolean/false】 options.scroll：定义 validateFieldsAndScroll 的滚动行为，详细配置见 dom-scroll-into-view config【Object/{}】 |
|
| getFieldDecorator(id, options) | 用于和表单进行双向绑定。id为必填输入控件唯一标志。支持嵌套式的写法。 options的配置： { initialValue：子节点的初始值，类型、可选值均由子节点决定(注意：由于内部校验时使用 rules：校验规则, trigger：收集子节点的值的时机, validateFirst：当某一规则校验不通过时，是否停止剩下的规则的校验, validateTrigger：收集子节点的值的时机, valuePropName：子节点的值的属性（如 Switch 的是 'checked'）， normalize：转换默认的 value 给控件, preserve：即便字段不再使用，也保留该字段的值, getValueFromEvent：可以把 onChange 的参数（如 event）转化为控件的值 } rules配置: enum：枚举类型， len：字段长度， max：最大长度， message：检验文案， min：最小长度， pattern：正则表达式校验， required：是否必选， transform：校验前转换字段值， type：内建校验类型，可选项： validator：自定义校验（注意，callback 必须被调用）：function(rule, value, callback) whitespace：必选时，空格是否会被视为错误 |
|
| isFieldTouched | 判断一个输入控件是否经历过 getFieldDecorator 的值收集时机 options.trigger |
|
| isFieldsTouched | 判断是否任一输入控件经历过 getFieldDecorator 的值收集时机 options.trigger |
|
| getFieldError | 获取某个输入控件的 Error，返回值为字符串数组：["Please input your username!"] | |
| getFieldsError | 获取一组输入控件的 Error ，如不传入参数，则获取全部组件的 Error。返回值为： {userName:["Please input your username!"],password:["Please input your Password!"]} |
|
| getFieldValue | 获取一个输入控件的值 | |
| getFieldsValue | 获取一组输入控件的值，如不传入参数，则获取全部组件的值 | |
| isFieldValidating | 判断一个输入控件是否在校验状态 | |
| resetFields | 重置一组输入控件的值（为 initialValue）与状态，如不传入参数，则重置所有组件 |
|
| setFields | 设置一组输入控件的值与错误状态 | |
| setFieldsValue | 设置一组输入控件的值（注意：不要在 componentWillReceiveProps 内使用，否则会导致死循环，原因） |
|
| validateFieldsAndScroll | 与 validateFields 相似，但校验完后，如果校验不通过的菜单域不在可见范围内，则自动滚动进可见范围 |
|