ant-design/components/form/demo/customized-form-controls.md

151 lines
4.2 KiB
Markdown
Raw Normal View History

---
2016-10-31 15:42:57 +08:00
order: 7
title:
zh-CN: 自定义表单控件
en-US: Customized Form Controls
---
## zh-CN
自定义或第三方的表单控件,也可以与 Form 组件一起使用。只要该组件遵循以下的约定:
2019-05-07 14:57:32 +08:00
> - 提供受控属性 `value` 或其它与 [`valuePropName`](http://ant.design/components/form/#getFieldDecorator-参数) 的值同名的属性。
> - 提供 `onChange` 事件或 [`trigger`](http://ant.design/components/form/#getFieldDecorator-参数) 的值同名的事件。
> - 支持 ref
> - React@16.3.0 之前只有 Class 组件支持。
> - React@16.3.0 及之后可以通过 [forwardRef](https://reactjs.org/docs/forwarding-refs.html) 添加 ref 支持。([示例](https://codesandbox.io/s/7wj199900x)
## en-US
Customized or third-party form controls can be used in Form, too. Controls must follow these conventions:
2019-05-07 14:57:32 +08:00
> - It has a controlled property `value` or other name which is equal to the value of [`valuePropName`](http://ant.design/components/form/?locale=en-US#getFieldDecorator's-parameters).
> - It has event `onChange` or an event which name is equal to the value of [`trigger`](http://ant.design/components/form/?locale=en-US#getFieldDecorator's-parameters).
> - Support ref:
> - Can only use class component before React@16.3.0.
> - Can use [forwardRef](https://reactjs.org/docs/forwarding-refs.html) to add ref support after React@16.3.0. ([Sample](https://codesandbox.io/s/7wj199900x))
```jsx
import { Form, Input, Select, Button } from 'antd';
2018-06-27 15:55:04 +08:00
2018-12-22 16:48:30 +08:00
const { Option } = Select;
class PriceInput extends React.Component {
static getDerivedStateFromProps(nextProps) {
// Should be a controlled component.
if ('value' in nextProps) {
return {
2018-10-21 13:29:43 +08:00
...(nextProps.value || {}),
};
}
return null;
}
constructor(props) {
super(props);
2018-04-18 14:08:06 +08:00
const value = props.value || {};
this.state = {
2016-11-21 18:29:36 +08:00
number: value.number || 0,
currency: value.currency || 'rmb',
};
}
2018-06-27 15:55:04 +08:00
2019-05-07 14:57:32 +08:00
handleNumberChange = e => {
2016-11-21 18:29:36 +08:00
const number = parseInt(e.target.value || 0, 10);
2019-08-05 18:38:10 +08:00
if (isNaN(number)) {
return;
}
if (!('value' in this.props)) {
2016-11-21 18:29:36 +08:00
this.setState({ number });
}
2016-11-21 18:29:36 +08:00
this.triggerChange({ number });
2019-05-07 14:57:32 +08:00
};
2018-06-27 15:55:04 +08:00
2019-05-07 14:57:32 +08:00
handleCurrencyChange = currency => {
2016-11-21 18:29:36 +08:00
if (!('value' in this.props)) {
this.setState({ currency });
}
this.triggerChange({ currency });
2019-05-07 14:57:32 +08:00
};
2018-06-27 15:55:04 +08:00
2019-05-07 14:57:32 +08:00
triggerChange = changedValue => {
// Should provide an event to pass value to Form.
2019-06-19 19:09:08 +08:00
const { onChange } = this.props;
if (onChange) {
2019-08-11 18:48:49 +08:00
onChange({
...this.state,
...changedValue,
});
}
2019-05-07 14:57:32 +08:00
};
2018-06-27 15:55:04 +08:00
render() {
2016-11-21 18:29:36 +08:00
const { size } = this.props;
2019-08-11 18:48:49 +08:00
const { currency, number } = this.state;
return (
2016-11-21 18:29:36 +08:00
<span>
<Input
type="text"
size={size}
2019-08-11 18:48:49 +08:00
value={number}
2016-11-21 18:29:36 +08:00
onChange={this.handleNumberChange}
style={{ width: '65%', marginRight: '3%' }}
/>
<Select
2019-08-11 18:48:49 +08:00
value={currency}
2016-11-21 18:29:36 +08:00
size={size}
style={{ width: '32%' }}
onChange={this.handleCurrencyChange}
>
<Option value="rmb">RMB</Option>
<Option value="dollar">Dollar</Option>
</Select>
</span>
);
}
}
class Demo extends React.Component {
2019-05-07 14:57:32 +08:00
handleSubmit = e => {
e.preventDefault();
this.props.form.validateFields((err, values) => {
2016-11-02 18:08:48 +08:00
if (!err) {
console.log('Received values of form: ', values);
}
});
2019-05-07 14:57:32 +08:00
};
2018-06-27 15:55:04 +08:00
checkPrice = (rule, value, callback) => {
2016-11-21 18:29:36 +08:00
if (value.number > 0) {
callback();
return;
}
callback('Price must greater than zero!');
2019-05-07 14:57:32 +08:00
};
2018-06-27 15:55:04 +08:00
render() {
const { getFieldDecorator } = this.props.form;
return (
<Form layout="inline" onSubmit={this.handleSubmit}>
2018-12-22 16:48:30 +08:00
<Form.Item label="Price">
2016-11-21 18:29:36 +08:00
{getFieldDecorator('price', {
initialValue: { number: 0, currency: 'rmb' },
rules: [{ validator: this.checkPrice }],
})(<PriceInput />)}
2018-12-22 16:48:30 +08:00
</Form.Item>
<Form.Item>
2019-05-07 14:57:32 +08:00
<Button type="primary" htmlType="submit">
Submit
</Button>
2018-12-22 16:48:30 +08:00
</Form.Item>
</Form>
);
}
}
2018-12-17 10:02:08 +08:00
const WrappedDemo = Form.create({ name: 'customized_form_controls' })(Demo);
ReactDOM.render(<WrappedDemo />, mountNode);
2019-05-07 14:57:32 +08:00
```