mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-29 20:08:37 +08:00
6954c3506c
* feat: add typescript demo add form typescript demo code * Update index.zh-CN.md * add TypeScript demo code add TypeScript demo code * Update index.en-US.md * Update index.zh-CN.md * Update index.en-US.md
184 lines
11 KiB
Markdown
184 lines
11 KiB
Markdown
---
|
||
category: Components
|
||
type: Data Entry
|
||
cols: 1
|
||
title: Form
|
||
---
|
||
|
||
Form is used to collect, validate, and submit the user input, usually contains various form items including checkbox, radio, input, select, and etc.
|
||
|
||
## Form
|
||
|
||
You can align the controls of a `form` using one of the following attributes：
|
||
|
||
- `horizontal`：to horizontally align the `label`s and controls of the fields. (Default)
|
||
- `vertical`：to vertically align the `label`s and controls of the fields.
|
||
- `inline`：to render form fields in one line.
|
||
|
||
## 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 />`.
|
||
|
||
```jsx
|
||
<Form.Item {...props}>
|
||
{children}
|
||
</Form.Item>
|
||
```
|
||
|
||
> PS：By default, large size controls are used within a form.
|
||
|
||
## API
|
||
|
||
### Form
|
||
|
||
**more example [rc-form](http://react-component.github.io/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
|
||
| layout | Define form layout(Support after 2.8) | 'horizontal'\|'vertical'\|'inline' | 'horizontal' |
|
||
| horizontal | Use horizontal layout(Deprecated after 2.8) | boolean | true |
|
||
| vertical | Use vertical layout(Deprecated after 2.8) | boolean | false |
|
||
| inline | Use inline alignment(Deprecated after 2.8) | boolean | false |
|
||
| onSubmit | Defines a function will be called if form data validation is successful. | Function(e:Event) | |
|
||
| hideRequiredMark | Hide required mark of all form items | Boolean | false |
|
||
|
||
### Form.create(options)
|
||
|
||
How to use：
|
||
|
||
```jsx
|
||
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 field value. Usage example: reading the values from Redux store. | Function(props): Object{ fieldName: Object{ value } } |
|
||
| onValuesChange | A handler while value of any field is changed | (props, values) => void |
|
||
|
||
If the form has been decorated by `Form.create` then it has `this.props.form` property. `this.props.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`.
|
||
|
||
| Method | 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.(Note: please don't use it in `componentWillReceiveProps`, otherwise, it will cause an endless loop, [more](https://github.com/ant-design/ant-design/issues/2985)) | Function({ [fieldName]: value } |
|
||
| setFields | | Function(obj: object) |
|
||
| setFields | Set the value and error of a field. [Code Sample](https://github.com/react-component/form/blob/3b9959b57ab30b41d8890ff30c79a7e7c383cad3/examples/server-validate.js#L74-L79) | Function({ [fieldName]: { value: any, errors: [Error] } }) |
|
||
| validateFields | Validate the specified fields and get theirs values and errors. If you don't specify the parameter of fieldNames, you will vaildate all fields. | 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) |
|
||
| getFieldsError | Get the specified fields' error. If you don't specify a parameter, you will get all fields' error. | Function([names: string[]]) |
|
||
| isFieldValidating | Check if the specified field is being validated. | Function(name) |
|
||
| 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 `options.trigger` event | (names?: string[]) => boolean |
|
||
| 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[]]) |
|
||
| getFieldDecorator | Two-way binding for form, please read below for details. | |
|
||
|
||
### this.props.form.validateFields/validateFieldsAndScroll([fieldNames: string[]], [options: object], callback: Function(errors, values))
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
|-----|-----|------|-------|
|
||
| options.first | If `true`, every field will stop validation at first failed rule | boolean | false |
|
||
| options.firstFields | Those fields will stop validation at first failed rule | String[] | [] |
|
||
| options.force | Should validate validated field again when `validateTrigger` is been triggered again | boolean | false |
|
||
| options.scroll | Config scroll behavior of `validateFieldsAndScroll`, more: [dom-scroll-into-view's config](https://github.com/yiminghe/dom-scroll-into-view#function-parameter) | Object | {} |
|
||
|
||
|
||
### this.props.form.getFieldDecorator(id, options)
|
||
|
||
After wrapped by `getFieldDecorator`, `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 to use `onChange` to collect data, but you still can listen to `onChange`(and so on) events.
|
||
2. You can not set value of form control via `value` `defaultValue` prop, and you should set default value with `initialValue` in `getFieldDecorator` instead.
|
||
3. You shouldn't to call `setState` manually, please use `this.props.form.setFieldsValue` to change value programmatically.
|
||
|
||
#### Special attention
|
||
|
||
1. `getFieldDecorator` can not be used to decorate stateless component.
|
||
1. If you use `react@<15.3.0`, then, you can't use `getFieldDecorator` in stateless component: https://github.com/facebook/react/pull/6534
|
||
|
||
#### getFieldDecorator(id, options) parameters
|
||
|
||
| Property | Description | Type | Default Value |
|
||
|-----------|-----------------------------------------|------|---------------|
|
||
| id | The unique identifier is required. support [nested fields format](https://github.com/react-component/form/pull/48). | string | |
|
||
| options.valuePropName | Props of children node, for example, the prop of Switch is 'checked'. | string | 'value' |
|
||
| options.initialValue | You can specify initial value, type, optional value of children node. (Note: Because `Form` will test equality with `===` internaly, we recommend to use vairable as `initialValue`, instead of literal) | | n/a |
|
||
| options.trigger | When to collect the value of children node | string | 'onChange' |
|
||
| options.getValueFromEvent | Specify how to get value from event or other onChange arguments | function(..args) | [reference](https://github.com/react-component/form#option-object) |
|
||
| options.validateTrigger | When to validate the value of children node. | string\|string[] | 'onChange' |
|
||
| options.rules | Includes validation rules. Please refer to "Validation Rules" part for details. | object[] | n/a |
|
||
| options.validateFirst | Whether stop validate on first rule of error for this field. | boolean | false |
|
||
| options.exclusive | Whether it is exclusive with other controls, particularly for Radio. | boolean | false |
|
||
| options.normalize | Normalize value to form component, [a select-all example](https://codepen.io/afc163/pen/JJVXzG?editors=001) | function(value, prevValue, allValues): any | - |
|
||
|
||
More option at [rc-form option](https://github.com/react-component/form#option-object)。
|
||
|
||
### Form.Item
|
||
|
||
Note:
|
||
* If Form.Item has multiple children that had been decorated by `getFieldDecorator`, `help` and `required` and `validateStatus` can't be generated automatically.
|
||
* Before `2.2.0`, form controls must be child of Form.Item, otherwise, you need to set `help`, `required` and `validateStatus` by yourself.
|
||
|
||
| Property | Description | Type | Default Value |
|
||
|---------------|--------------------------------------|--------|---------------|
|
||
| label | Label text | string\|ReactNode | |
|
||
| labelCol | The layout of label. You can set `span` `offset` to something like `{span: 3, offset: 12}` or `sm: {span: 3, offset: 12}` same as with `<Col>` | [object](https://ant.design/components/grid/#Col) | |
|
||
| wrapperCol | The layout for input controls, same as `labelCol` | [object](https://ant.design/components/grid/#Col) | |
|
||
| help | The prompt message. If not provided, the prompt message will be generated by the validation rule. | string\|ReactNode | |
|
||
| extra | The extra prompt message. It is similar to help. Usage example: to display error message and prompt message at the same time. | string\|ReactNode | |
|
||
| required | Whether provided or not, it will be generated by the validation rule. | boolean | false |
|
||
| validateStatus | The validation status. If not provided, it will be generated by validation rule. options: 'success' 'warning' 'error' 'validating' | string | |
|
||
| hasFeedback | Used with `validateStatus`, this option specifies the validation status icon. Recommended to be used only with `Input`. | boolean | false |
|
||
| colon | Used with `label`, whether to display `:` after label text. | boolean | true |
|
||
|
||
### Validation Rules
|
||
|
||
Property | Description | Type | Default Value
|
||
---------|-------------|------|--------------
|
||
message | validation error message | string | -
|
||
type | built-in validation type, [available options](https://github.com/yiminghe/async-validator#type) | string | 'string'
|
||
required | indicates whether field is required | boolean | `false`
|
||
whitespace | treat required fields that only contain whitespace as errors | boolean | `false`
|
||
len | validate an exact length of a field | number | -
|
||
min | validate a min length of a field | number | -
|
||
max | validate a max length of a field | number | -
|
||
enum | validate a value from a list of possible values | string | -
|
||
pattern | validate from a regular expression | RegExp | -
|
||
transform | transform a value before validation | function(value) => transformedValue:any | -
|
||
validator | custom validate function (Note: [callback must be called](https://github.com/ant-design/ant-design/issues/5155)) | function(rule, value, callback) | -
|
||
|
||
See more advanced usage at [async-validator](https://github.com/yiminghe/async-validator).
|
||
|
||
<style>
|
||
.code-box-demo .ant-form:not(.ant-form-inline):not(.ant-form-vertical) {
|
||
max-width: 540px;
|
||
}
|
||
</style>
|
||
|
||
|
||
## Using in TypeScript
|
||
|
||
```jsx
|
||
import { Form } from 'antd';
|
||
import { FormComponentProps } from 'antd/lib/form/Form';
|
||
|
||
interface UserFormProps extends FormComponentProps {
|
||
age: number;
|
||
name: string;
|
||
}
|
||
|
||
class UserForm extends React.Component<UserFormProps, any> {
|
||
|
||
}
|
||
|