diff --git a/components/form/index.en-US.md b/components/form/index.en-US.md index 0af4547d0..78b38a6f6 100644 --- a/components/form/index.en-US.md +++ b/components/form/index.en-US.md @@ -54,7 +54,7 @@ The following `options` are available: If the form has been decorated by `Form.create` then it has `this.form` property. `this.form` provides some APIs as follows: -> Note: Before using `getFieldsValue` `getFieldValue` `setFieldsValue` and so on, please make sure that corresponding field had been registered with `getFieldDecorator`. +> Note: Before using `getFieldsValue` `getFieldValue` `setFieldsValue` and so on, please make sure that corresponding field had been registered with `getFieldDecorator` or `v-decorator`. | Method | Description | Type | | ------ | ----------- | ---- | @@ -63,8 +63,8 @@ If the form has been decorated by `Form.create` then it has `this.form` property | getFieldsError | Get the specified fields' error. If you don't specify a parameter, you will get all fields' error. | Function(\[names: string\[]]) | | getFieldsValue | Get the specified fields' values. If you don't specify a parameter, you will get all fields' values. | Function(\[fieldNames: string\[]]) | | getFieldValue | Get the value of a field. | Function(fieldName: string) | -| isFieldsTouched | Check whether any of fields is touched by `getFieldDecorator`'s `options.trigger` event | (names?: string\[]) => boolean | -| isFieldTouched | Check whether a field is touched by `getFieldDecorator`'s `options.trigger` event | (name: string) => boolean | +| isFieldsTouched | Check whether any of fields is touched by `getFieldDecorator`'s or `v-decorator`'s `options.trigger` event | (names?: string\[]) => boolean | +| isFieldTouched | Check whether a field is touched by `getFieldDecorator`'s or `v-decorator`'s `options.trigger` event | (name: string) => boolean | | isFieldValidating | Check if the specified field is being validated. | Function(name) | | resetFields | Reset the specified fields' value(to `initialValue`) and status. If you don't specify a parameter, all the fields will be reset. | Function(\[names: string\[]]) | | setFields | Set value and error state of fields. | ({
  \[fieldName\]: {value: any, errors: \[Error\] }
}) => void | @@ -137,7 +137,7 @@ To mark the returned fields data in `mapPropsToFields`, [demo](#components-form- After wrapped by `getFieldDecorator` or `v-decorator`, `value`(or other property defined by `valuePropName`) `onChange`(or other property defined by `trigger`) props will be added to form controls,the flow of form data will be handled by Form which will cause: 1. You shouldn't use `onChange` to collect data, but you still can listen to `onChange`(and so on) events. -2. You cannot set value of form control via `value` `defaultValue` prop, and you should set default value with `initialValue` in `getFieldDecorator` instead. +2. You cannot set value of form control via `value` `defaultValue` prop, and you should set default value with `initialValue` in `getFieldDecorator` or `v-decorator` instead. 3. You shouldn't call `v-model` manually, please use `this.form.setFieldsValue` to change value programmatically. #### Special attention diff --git a/components/form/index.zh-CN.md b/components/form/index.zh-CN.md index 27a551076..ce230ca6d 100644 --- a/components/form/index.zh-CN.md +++ b/components/form/index.zh-CN.md @@ -52,7 +52,7 @@ export default { 经过 `Form.create` 包装的组件将会自带 `this.form` 属性,`this.form` 提供的 API 如下: -> 注意:使用 `getFieldsValue` `getFieldValue` `setFieldsValue` 等时,应确保对应的 field 已经用 `getFieldDecorator` 注册过了。 +> 注意:使用 `getFieldsValue` `getFieldValue` `setFieldsValue` 等时,应确保对应的 field 已经用 `getFieldDecorator` 或 `v-decorator` 注册过了。 | 方法      | 说明                                     | 类型       | | ------- | -------------------------------------- | -------- | @@ -61,8 +61,8 @@ export default { | getFieldsError | 获取一组输入控件的 Error ,如不传入参数,则获取全部组件的 Error | Function(\[names: string\[]]) | | getFieldsValue | 获取一组输入控件的值,如不传入参数,则获取全部组件的值 | Function(\[fieldNames: string\[]]) | | getFieldValue | 获取一个输入控件的值 | Function(fieldName: string) | -| isFieldsTouched | 判断是否任一输入控件经历过 `getFieldDecorator` 的值收集时机 `options.trigger` | (names?: string\[]) => boolean | -| isFieldTouched | 判断一个输入控件是否经历过 `getFieldDecorator` 的值收集时机 `options.trigger` | (name: string) => boolean | +| isFieldsTouched | 判断是否任一输入控件经历过 `getFieldDecorator` 或 `v-decorator` 的值收集时机 `options.trigger` | (names?: string\[]) => boolean | +| isFieldTouched | 判断一个输入控件是否经历过 `getFieldDecorator` 或 `v-decorator` 的值收集时机 `options.trigger` | (name: string) => boolean | | isFieldValidating | 判断一个输入控件是否在校验状态 | Function(name) | | resetFields | 重置一组输入控件的值(为 `initialValue`)与状态,如不传入参数,则重置所有组件 | Function(\[names: string\[]]) | | setFields | 设置一组输入控件的值与错误状态。 | Function({ [fieldName]: { value: any, errors: [Error] } }) | @@ -136,13 +136,13 @@ validateFields(['field1', 'field2'], options, (errors, values) => { 经过 `getFieldDecorator`或`v-decorator` 包装的控件,表单控件会自动添加 `value`(或 `valuePropName` 指定的其他属性) `onChange`(或 `trigger` 指定的其他属性),数据同步将被 Form 接管,这会导致以下结果: 1. 你**不再需要也不应该**用 `onChange` 来做同步,但还是可以继续监听 `onChange` 等事件。 -2. 你不能用控件的 `value` `defaultValue` 等属性来设置表单域的值,默认值可以用 `getFieldDecorator` 里的 `initialValue`。 +2. 你不能用控件的 `value` `defaultValue` 等属性来设置表单域的值,默认值可以用 `getFieldDecorator` 或 `v-decorator` 里的 `initialValue`。 3. 你不应该用 `v-model`,可以使用 `this.form.setFieldsValue` 来动态改变表单值。 #### 特别注意 -1. `getFieldDecorator`和`v-decorator` 不能用于装饰纯函数组件。 -2. `getFieldDecorator`和`v-decorator` 调用不能位于纯函数组件中 。 +1. `getFieldDecorator` 和 `v-decorator` 不能用于装饰纯函数组件。 +2. `getFieldDecorator` 和 `v-decorator` 调用不能位于纯函数组件中 。 #### getFieldDecorator(id, options) 和 v-decorator="[id, options]" 参数