baseForm.tsx 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. /* eslint-disable prefer-template, max-len, @typescript-eslint/no-unused-vars */
  2. import React from 'react';
  3. import classNames from 'classnames';
  4. import PropTypes from 'prop-types';
  5. import FormFoundation, { BaseFormAdapter } from '@douyinfe/semi-foundation/form/foundation';
  6. import { strings, cssClasses } from '@douyinfe/semi-foundation/form/constants';
  7. import { getUuidv4 } from '@douyinfe/semi-foundation/utils/uuid';
  8. import warning from '@douyinfe/semi-foundation/utils/warning';
  9. import BaseComponent from '../_base/baseComponent';
  10. import { FormStateContext, FormApiContext, FormUpdaterContext } from './context';
  11. import { isEmptyChildren } from '../_base/reactUtils';
  12. import Row from '../grid/row';
  13. import { cloneDeep } from '../_utils/index';
  14. import Slot from './slot';
  15. import Section from './section';
  16. import Label from './label';
  17. import ErrorMessage from './errorMessage';
  18. import FormInputGroup from './group';
  19. import { noop } from 'lodash';
  20. import '@douyinfe/semi-foundation/form/form.scss';
  21. import { FormInput,
  22. FormInputNumber,
  23. FormTextArea,
  24. FormSelect,
  25. FormCheckboxGroup,
  26. FormCheckbox,
  27. FormRadioGroup,
  28. FormRadio,
  29. FormDatePicker,
  30. FormSwitch,
  31. FormSlider,
  32. FormTimePicker,
  33. FormTreeSelect,
  34. FormCascader,
  35. FormRating,
  36. FormAutoComplete,
  37. FormUpload,
  38. FormTagInput } from './field';
  39. import {
  40. BaseFormProps,
  41. FormState,
  42. FormApi,
  43. ErrorMsg
  44. } from './interface';
  45. const prefix = cssClasses.PREFIX;
  46. interface BaseFormState {
  47. formId: string;
  48. }
  49. class Form extends BaseComponent<BaseFormProps, BaseFormState> {
  50. static propTypes = {
  51. onSubmit: PropTypes.func,
  52. onSubmitFail: PropTypes.func,
  53. /* Triggered from update, including field mount/unmount/value change/blur/verification status change/error prompt change, input parameter is formState, currentField */
  54. onChange: PropTypes.func,
  55. onReset: PropTypes.func,
  56. // Triggered when the value of the form is updated, only when the value of the subfield changes. The entry parameter is formState.values
  57. onValueChange: PropTypes.func,
  58. initValues: PropTypes.object,
  59. getFormApi: PropTypes.func,
  60. component: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
  61. render: PropTypes.func,
  62. validateFields: PropTypes.func,
  63. style: PropTypes.object,
  64. className: PropTypes.string,
  65. layout: PropTypes.oneOf(strings.LAYOUT),
  66. labelPosition: PropTypes.oneOf(strings.LABEL_POS),
  67. labelWidth: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
  68. labelAlign: PropTypes.oneOf(strings.LABEL_ALIGN),
  69. labelCol: PropTypes.object, // Control labelCol {span: number, offset: number} for all field child nodes
  70. wrapperCol: PropTypes.object, // Control wrapperCol {span: number, offset: number} for all field child nodes
  71. allowEmpty: PropTypes.bool,
  72. autoScrollToError: PropTypes.oneOfType([PropTypes.bool, PropTypes.object]),
  73. disabled: PropTypes.bool,
  74. showValidateIcon: PropTypes.bool,
  75. extraTextPosition: PropTypes.oneOf(strings.EXTRA_POS),
  76. };
  77. static defaultProps = {
  78. onChange: noop,
  79. onSubmitFail: noop,
  80. onSubmit: noop,
  81. onReset: noop,
  82. onValueChange: noop,
  83. layout: 'vertical',
  84. labelPosition: 'top',
  85. allowEmpty: false,
  86. autoScrollToError: false,
  87. showValidateIcon: true,
  88. };
  89. static Input = FormInput;
  90. static TextArea = FormTextArea;
  91. static InputNumber = FormInputNumber;
  92. static Select = FormSelect;
  93. static Checkbox = FormCheckbox;
  94. static CheckboxGroup = FormCheckboxGroup;
  95. static Radio = FormRadio;
  96. static RadioGroup = FormRadioGroup;
  97. static DatePicker = FormDatePicker;
  98. static TimePicker = FormTimePicker;
  99. static Switch = FormSwitch;
  100. static Slider = FormSlider;
  101. static TreeSelect = FormTreeSelect;
  102. static Cascader = FormCascader;
  103. static Rating = FormRating;
  104. static AutoComplete = FormAutoComplete;
  105. static Upload = FormUpload;
  106. static TagInput = FormTagInput;
  107. static Slot = Slot;
  108. static ErrorMessage = ErrorMessage;
  109. static InputGroup = FormInputGroup;
  110. static Label = Label;
  111. static Section = Section;
  112. formApi: FormApi;
  113. constructor(props: BaseFormProps) {
  114. super(props);
  115. this.state = {
  116. formId: getUuidv4(),
  117. };
  118. warning(
  119. Boolean(props.component && props.render),
  120. '[Semi Form] You should not use <Form component> and <Form render> in ths same time; <Form render> will be ignored'
  121. );
  122. warning(
  123. props.component && props.children && !isEmptyChildren(props.children),
  124. '[Semi Form] You should not use <Form component> and <Form>{children}</Form> in ths same time; <Form>{children}</Form> will be ignored'
  125. );
  126. warning(
  127. props.render && props.children && !isEmptyChildren(props.children),
  128. '[Semi Form] You should not use <Form render> and <Form>{children}</Form> in ths same time; <Form>{children}</Form> will be ignored'
  129. );
  130. this.submit = this.submit.bind(this);
  131. this.reset = this.reset.bind(this);
  132. this.foundation = new FormFoundation(this.adapter);
  133. this.formApi = this.foundation.getFormApi();
  134. if (this.props.getFormApi) {
  135. this.props.getFormApi(this.formApi);
  136. }
  137. }
  138. componentWillUnmount() {
  139. this.foundation.destroy();
  140. this.foundation = null;
  141. this.formApi = null;
  142. }
  143. get adapter(): BaseFormAdapter<BaseFormProps, BaseFormState> {
  144. return {
  145. ...super.adapter,
  146. cloneDeep,
  147. notifySubmit: (values: any) => {
  148. this.props.onSubmit(values);
  149. },
  150. notifySubmitFail: (errors: ErrorMsg, values: any) => {
  151. this.props.onSubmitFail(errors, values);
  152. },
  153. forceUpdate: () => {
  154. this.forceUpdate();
  155. },
  156. notifyChange: (formState: FormState) => {
  157. this.props.onChange(formState);
  158. },
  159. notifyValueChange: (values: any, changedValues: any) => {
  160. this.props.onValueChange(values, changedValues);
  161. },
  162. notifyReset: () => {
  163. this.props.onReset();
  164. },
  165. getInitValues: () => this.props.initValues,
  166. getFormProps: (keys: undefined | string | Array<string>) => {
  167. if (typeof keys === 'undefined') {
  168. return this.props;
  169. } else if (typeof keys === 'string') {
  170. return this.props[keys];
  171. } else {
  172. const props = {};
  173. keys.forEach(key => {
  174. props[key] = this.props[key];
  175. });
  176. return props;
  177. }
  178. },
  179. getAllErrorDOM: () => {
  180. const { formId } = this.state;
  181. return document.querySelectorAll(
  182. `form[x-form-id="${formId}"] .${cssClasses.PREFIX}-field-error-message`
  183. );
  184. },
  185. getFieldDOM: (field: string) =>
  186. document.querySelector(`.${cssClasses.PREFIX}-field[x-field-id="${field}"]`),
  187. };
  188. }
  189. get content() {
  190. const { children, component, render } = this.props;
  191. const formState = this.foundation.getFormState();
  192. const props = {
  193. formState,
  194. formApi: this.foundation.getFormApi(),
  195. values: formState.values,
  196. };
  197. if (component) {
  198. return React.createElement(component, props, children);
  199. }
  200. if (render) {
  201. return render(props);
  202. }
  203. if (typeof children === 'function') {
  204. return children(props);
  205. }
  206. return children;
  207. }
  208. submit(e: React.FormEvent<HTMLFormElement>) {
  209. e.preventDefault();
  210. this.foundation.submit();
  211. }
  212. reset(e: React.FormEvent<HTMLFormElement>) {
  213. e.preventDefault();
  214. this.foundation.reset();
  215. }
  216. render() {
  217. const needClone = false;
  218. const formState = this.foundation.getFormState(needClone);
  219. const updaterApi = this.foundation.getModifyFormStateApi();
  220. const { formId } = this.state;
  221. const {
  222. children,
  223. getFormApi,
  224. onChange,
  225. onSubmit,
  226. onSubmitFail,
  227. onValueChange,
  228. component,
  229. render,
  230. validateFields,
  231. initValues,
  232. layout,
  233. style,
  234. className,
  235. labelPosition,
  236. labelWidth,
  237. labelAlign,
  238. labelCol,
  239. wrapperCol,
  240. allowEmpty,
  241. autoScrollToError,
  242. showValidateIcon,
  243. extraTextPosition,
  244. ...rest
  245. } = this.props;
  246. const formCls = classNames(prefix, className, {
  247. [prefix + '-vertical']: layout === 'vertical',
  248. [prefix + '-horizontal']: layout === 'horizontal',
  249. });
  250. const showldAppendRow = wrapperCol && labelCol;
  251. const formContent = (
  252. <form
  253. style={style}
  254. {...rest}
  255. onReset={this.reset}
  256. onSubmit={this.submit}
  257. className={formCls}
  258. x-form-id={formId}
  259. >
  260. {this.content}
  261. </form>
  262. );
  263. const withRowForm = <Row>{formContent}</Row>;
  264. return (
  265. <FormUpdaterContext.Provider value={updaterApi}>
  266. <FormApiContext.Provider value={this.formApi}>
  267. <FormStateContext.Provider value={formState}>
  268. {showldAppendRow ? withRowForm : formContent}
  269. </FormStateContext.Provider>
  270. </FormApiContext.Provider>
  271. </FormUpdaterContext.Provider>
  272. );
  273. }
  274. }
  275. export default Form;