import React from 'react'; import PropTypes from 'prop-types'; import classNames from 'classnames'; import createDOMForm from 'rc-form/lib/createDOMForm'; import PureRenderMixin from 'rc-util/lib/PureRenderMixin'; import omit from 'omit.js'; import assign from 'object-assign'; import warning from '../_util/warning'; import FormItem from './FormItem'; import { FIELD_META_PROP } from './constants'; export interface FormCreateOption { onFieldsChange?: (props: any, fields: Array) => void; onValuesChange?: (props: any, values: any) => void; mapPropsToFields?: (props: any) => void; withRef?: boolean; } export interface FormProps { layout?: 'horizontal' | 'inline' | 'vertical'; horizontal?: boolean; inline?: boolean; vertical?: boolean; form?: WrappedFormUtils; onSubmit?: React.FormEventHandler; style?: React.CSSProperties; className?: string; prefixCls?: string; hideRequiredMark?: boolean; } export type ValidateCallback = (erros: any, values: any) => void; // function create export type WrappedFormUtils = { /** 获取一组输入控件的值,如不传入参数,则获取全部组件的值 */ getFieldsValue(fieldNames?: Array): Object; /** 获取一个输入控件的值*/ getFieldValue(fieldName: string): any; /** 设置一组输入控件的值*/ setFieldsValue(obj: Object): void; /** 设置一组输入控件的值*/ setFields(obj: Object): void; /** 校验并获取一组输入域的值与 Error */ validateFields(fieldNames: Array, options: Object, callback: ValidateCallback): any; validateFields(fieldNames: Array, callback: ValidateCallback): any; validateFields(options: Object, callback: ValidateCallback): any; validateFields(callback: ValidateCallback): any; /** 与 `validateFields` 相似,但校验完后,如果校验不通过的菜单域不在可见范围内,则自动滚动进可见范围 */ validateFieldsAndScroll(fieldNames?: Array, options?: Object, callback?: ValidateCallback): void; validateFieldsAndScroll(fieldNames?: Array, callback?: ValidateCallback): void; validateFieldsAndScroll(options?: Object, callback?: ValidateCallback): void; validateFieldsAndScroll(callback?: ValidateCallback): void; /** 获取某个输入控件的 Error */ getFieldError(name: string): Object[]; getFieldsError(names?: Array): Object; /** 判断一个输入控件是否在校验状态*/ isFieldValidating(name: string): boolean; isFieldTouched(name: string): boolean; isFieldsTouched(names?: Array): boolean; /** 重置一组输入控件的值与状态,如不传入参数,则重置所有组件 */ resetFields(names?: Array): void; getFieldDecorator(id: string, options?: { /** 子节点的值的属性,如 Checkbox 的是 'checked' */ valuePropName?: string; /** 子节点的初始值,类型、可选值均由子节点决定 */ initialValue?: any; /** 收集子节点的值的时机 */ trigger?: string; /** 可以把 onChange 的参数转化为控件的值,例如 DatePicker 可设为:(date, dateString) => dateString */ getValueFromEvent?: (...args: any[]) => any; /** 校验子节点值的时机 */ validateTrigger?: string | string[]; /** 校验规则,参见 [async-validator](https://github.com/yiminghe/async-validator) */ rules?: Array; /** 是否和其他控件互斥,特别用于 Radio 单选控件 */ exclusive?: boolean; }): (node: React.ReactNode) => React.ReactNode; }; export interface FormComponentProps { form: WrappedFormUtils; } // https://github.com/DefinitelyTyped/DefinitelyTyped/issues/9951 export interface ComponentDecorator { (component: React.ComponentClass): any; } export default class Form extends React.Component { static defaultProps = { prefixCls: 'ant-form', layout: 'horizontal', hideRequiredMark: false, onSubmit(e) { e.preventDefault(); }, }; static propTypes = { prefixCls: PropTypes.string, layout: PropTypes.oneOf(['horizontal', 'inline', 'vertical']), children: PropTypes.any, onSubmit: PropTypes.func, hideRequiredMark: PropTypes.bool, }; static childContextTypes = { vertical: PropTypes.bool, }; static Item = FormItem; static create = function(options?: FormCreateOption): ComponentDecorator { const formWrapper = createDOMForm(assign({ fieldNameProp: 'id', }, options, { fieldMetaProp: FIELD_META_PROP, })); /* eslint-disable react/prefer-es6-class */ return (Component) => formWrapper(React.createClass({ propTypes: { form: PropTypes.object.isRequired, }, childContextTypes: { form: PropTypes.object.isRequired, }, getChildContext() { return { form: this.props.form, }; }, componentWillMount() { this.__getFieldProps = this.props.form.getFieldProps; }, deprecatedGetFieldProps(name, option) { warning( false, '`getFieldProps` is not recommended, please use `getFieldDecorator` instead, ' + 'see: http://u.ant.design/get-field-decorator', ); return this.__getFieldProps(name, option); }, render() { this.props.form.getFieldProps = this.deprecatedGetFieldProps; const withRef: any = {}; if (options && options.withRef) { withRef.ref = 'formWrappedComponent'; } return ; }, })); }; constructor(props) { super(props); warning(!props.form, 'It is unnecessary to pass `form` to `Form` after antd@1.7.0.'); } shouldComponentUpdate(...args) { return PureRenderMixin.shouldComponentUpdate.apply(this, args); } getChildContext() { const { layout, vertical } = this.props; return { vertical: layout === 'vertical' || vertical, }; } render() { const { prefixCls, hideRequiredMark, className = '', layout, // @deprecated inline, horizontal, vertical, } = this.props; warning( !inline && !horizontal && !vertical, '`Form[inline|horizontal|vertical]` is deprecated, please use `Form[layout]` instead.', ); const formClassName = classNames(prefixCls, { [`${prefixCls}-horizontal`]: (!inline && !vertical && layout === 'horizontal') || horizontal, [`${prefixCls}-vertical`]: layout === 'vertical' || vertical, [`${prefixCls}-inline`]: layout === 'inline' || inline, [`${prefixCls}-hide-required-mark`]: hideRequiredMark, }, className); const formProps = omit(this.props, [ 'prefixCls', 'className', 'layout', 'inline', 'horizontal', 'vertical', 'form', 'hideRequiredMark', ]); return
; } }