2019-07-03 20:14:39 +08:00
---
2019-12-27 15:36:27 +08:00
order: 6.1
2019-07-03 20:14:39 +08:00
title:
zh-CN: 自定义表单控件
en-US: Customized Form Controls
---
## zh-CN
自定义或第三方的表单控件,也可以与 Form 组件一起使用。只要该组件遵循以下的约定:
2021-03-01 18:22:03 +08:00
> - 提供受控属性 `value` 或其它与 [`valuePropName`](https://ant.design/components/form-cn/#Form.Item) 的值同名的属性。
> - 提供 `onChange` 事件或 [`trigger`](https://ant.design/components/form-cn/#Form.Item) 的值同名的事件。
2019-07-03 20:14:39 +08:00
## en-US
Customized or third-party form controls can be used in Form, too. Controls must follow these conventions:
2021-03-01 18:22:03 +08:00
> - It has a controlled property `value` or other name which is equal to the value of [`valuePropName`](https://ant.design/components/form/#Form.Item).
> - It has event `onChange` or an event which name is equal to the value of [`trigger`](https://ant.design/components/form/#Form.Item).
2019-07-03 20:14:39 +08:00
```tsx
2022-05-23 14:37:16 +08:00
import { Button, Form, Input, Select } from 'antd';
2020-01-22 12:11:49 +08:00
import React, { useState } from 'react';
2019-07-03 20:14:39 +08:00
const { Option } = Select;
2020-12-17 15:09:18 +08:00
type Currency = 'rmb' | 'dollar';
2019-07-03 20:14:39 +08:00
interface PriceValue {
number?: number;
2020-12-17 15:09:18 +08:00
currency?: Currency;
2019-07-03 20:14:39 +08:00
}
interface PriceInputProps {
value?: PriceValue;
onChange?: (value: PriceValue) => void;
}
const PriceInput: React.FC< PriceInputProps > = ({ value = {}, onChange }) => {
2020-01-22 12:11:49 +08:00
const [number, setNumber] = useState(0);
2020-12-17 15:09:18 +08:00
const [currency, setCurrency] = useState< Currency > ('rmb');
2019-07-03 20:14:39 +08:00
2020-12-17 15:09:18 +08:00
const triggerChange = (changedValue: { number?: number; currency?: Currency }) => {
2021-02-19 18:26:53 +08:00
onChange?.({ number, currency, ...value, ...changedValue });
2019-07-03 20:14:39 +08:00
};
2020-12-17 15:09:18 +08:00
const onNumberChange = (e: React.ChangeEvent< HTMLInputElement > ) => {
const newNumber = parseInt(e.target.value || '0', 10);
2019-07-03 20:14:39 +08:00
if (Number.isNaN(number)) {
return;
}
if (!('number' in value)) {
setNumber(newNumber);
}
triggerChange({ number: newNumber });
};
2020-12-17 15:09:18 +08:00
const onCurrencyChange = (newCurrency: Currency) => {
2019-07-03 20:14:39 +08:00
if (!('currency' in value)) {
setCurrency(newCurrency);
}
triggerChange({ currency: newCurrency });
};
return (
< span >
< Input
type="text"
value={value.number || number}
onChange={onNumberChange}
2020-03-30 21:23:05 +08:00
style={{ width: 100 }}
2019-07-03 20:14:39 +08:00
/>
2020-03-30 21:23:05 +08:00
< Select
value={value.currency || currency}
style={{ width: 80, margin: '0 8px' }}
onChange={onCurrencyChange}
>
2019-07-03 20:14:39 +08:00
< Option value = "rmb" > RMB< / Option >
< Option value = "dollar" > Dollar< / Option >
< / Select >
< / span >
);
};
2022-05-19 09:46:26 +08:00
const App: React.FC = () => {
2020-12-17 15:09:18 +08:00
const onFinish = (values: any) => {
2020-02-26 11:27:15 +08:00
console.log('Received values from form: ', values);
2019-07-03 20:14:39 +08:00
};
2020-12-17 15:09:18 +08:00
const checkPrice = (_: any, value: { number: number }) => {
2019-07-03 20:14:39 +08:00
if (value.number > 0) {
return Promise.resolve();
}
2021-02-23 10:45:11 +08:00
return Promise.reject(new Error('Price must be greater than zero!'));
2019-07-03 20:14:39 +08:00
};
return (
< Form
name="customized_form_controls"
layout="inline"
onFinish={onFinish}
initialValues={{
price: {
number: 0,
currency: 'rmb',
},
}}
>
< Form.Item name = "price" label = "Price" rules = {[{ validator: checkPrice } ] } >
< PriceInput / >
< / Form.Item >
< Form.Item >
< Button type = "primary" htmlType = "submit" >
Submit
< / Button >
< / Form.Item >
< / Form >
);
};
2022-05-19 09:46:26 +08:00
export default App;
2019-07-03 20:14:39 +08:00
```