ant-design/components/form/index.en-US.md

category	type	cols	english
Components	Form Controls	1	Form

Forms are used to collect, validate, and submit the user input. They contain one or more form items. There are many types of form items including checkbox, radio, input, select, and more.

Form

You can align the controls of a form using one of the following attributes：

• horizontal：to horizontally align the labels and controls of the fields.
• inline：to render the labels and controls of the fields in one line (by setting the display property of form controls to inline-block).

Form fields

A form consists of one or more form fields whose type includes input, textarea, checkbox, radio, select, tag, and more. A form field is defined using <Form.Item />.

<Form.Item {...props}>
  {children}
</Form.Item>

PS：By default, large size controls are used within a form.

API

Form

more example rc-form。

Property	Description	Type	Default Value
form	Decorated by Form.create() will be automatically set this.props.form property, so just pass to form, you don't need to set it by yourself after 1.7.0.	object	n/a
vertical	Use vertical layout.	boolean	false
horizontal	Use horizontal layout.	boolean	false
inline	Use inline alignment.	boolean	false
onSubmit	Defines a function will be called if form data validation is successful.	Function(e:Event)
prefixCls	Set the CSS class name of form component (optional).	string	'ant-form'

Form.create(options)

How to use：

class CustomizedForm extends React.Component {}

CustomizedForm = Form.create({})(CustomizedForm);

The following options are available:

Property	Description	Type
onFieldsChange	Specify a function that will be called when the value a Form.Item gets changed. Usage example: saving the field's value to Redux store.	Function(props, fields)
mapPropsToFields	Convert props to corresponding field value. Usage example: reading the values from Redux store.	Function(props): Object{ fieldName: Object{ value } }

If the form has been decorated by Form.create then it has this.props.form property. this.props.form provides some APIs as follows:

Property	Description	Type
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)
setFieldsValue	Set the value of a field.	Function(obj: object)
setFields	Set the value and error of a field.	Function(obj: object)
validateFields	Validate the specified fields and get theirs values and errors.	Function([fieldNames: string[]], [options: object], callback: Function(errors, values))
validateFieldsAndScroll	This function is similar to validateFields, but after validation, if the target field is not in visible area of form, form will be automatically scrolled to the target field area.	same as validateFields
getFieldError	Get the error of a field.	Function(name)
isFieldValidating	Check if the specified field is being validated.	Function(name)
resetFields	Reset the specified fields' value and status. If you don't specify a parameter, all the fields will be reset.	Function([names: string[]])
getFieldProps	Two-way binding for form, please read below for details.

this.props.form.getFieldProps(id, options)

Special attention

If you use react@<15.3.0, then, you can't use getFieldProps in functional components: https://github.com/facebook/react/pull/6534

The return value of getFieldProps contains id、value(or any other props valuePropName that you specified),ref,onChange(or any other trigger validateTrigger that you specified), shouldn't set same property again in order to avoid conflict. If you concerntate on the details on return value, you can print them to console by console.log.

Don't use defaultValue in form, please use initialValue instead of it.

getFieldProps options

Property	Description	Type	Default Value
options.id	The unique identifier is required.	string
options.valuePropName	Props of children node, for exmaple, the prop of Switch is 'checked'.	string	'value'
options.initialValue	You can specify initial value, type, optional value of children node.		n/a
options.trigger	When to collect the value of children node	string	'onChange'
options.getValueFromEvent	To convert parameters of onChange to the value of control, for example, set value of DatePicker: (date, dateString) => dateString	function(..args)	reference
options.validateTrigger	When to validate the value of children node.	string	'onChange'
options.rules	Includes validation rules. Please refer to async-validator for details.	array	n/a
options.onXXX	Because getFieldProps will replace events like onChange, trigger, validateTrigger, if you still want to bind these events, you may set them in options	function	n/a
options.exclusive	Whether it is exclusive with other controls, particularly for Radio.	boolean	false

Form.Item

If Form.Item has multiple children, help, required, and validateStatus can't be generated automatically.

Property	Description	Type	Optional	Default Value
label	Label text	string
labelCol	The layout of label. You can set span offset to something like {span: 3, offset: 12} same as with <Col>	object
wrapperCol	The layout for input controls. Same as labelCol	object
help	The prompt message. If not provided, the prompt message will be generated by the validation rule.	string
extra	The extra prompt message. It is similar to help. Usage example: to display error message and prompt message at the same time.	string
required	Whether provided or not, it will be generated by the validation rule.	bool		false
validateStatus	The validation status. If not provided, it will be generated by validation rule	string	'success' 'warning' 'error' 'validating'
hasFeedback	Used with validateStatus, this option specifies the validation status icon. Recommended to be used only with Input.	bool		false
prefixCls	The CSS class name of form item (optional).	string		'ant-form'