rsuite 5.9.0 → 5.10.0

package/esm/Form/Form.d.ts

@@ -33,7 +33,7 @@ export interface FormProps<T = Record<string, any>, errorMsgType = any, E = {
     /** The error message comes from context */
     errorFromContext?: boolean;
     /** Callback fired when data changing */
-    onChange?: (formValue: T, event: React.SyntheticEvent) => void;
+    onChange?: (formValue: T, event?: React.SyntheticEvent) => void;
     /** Callback fired when error checking */
     onError?: (formError: E) => void;
     /** Callback fired when data cheking */

package/esm/Form/Form.js

@@ -199,6 +199,16 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       resetErrors: resetErrors
     };
   });
+  var removeFieldError = useCallback(function (name) {
+    var formError = omit(getFormError(), [name]);
+    setFormError(formError);
+    onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
+  }, [getFormError, onCheck]);
+  var removeFieldValue = useCallback(function (name) {
+    var formValue = omit(getFormValue(), [name]);
+    setFormValue(formValue);
+    onChange === null || onChange === void 0 ? void 0 : onChange(formValue);
+  }, [getFormValue, onChange]);
   var handleSubmit = useCallback(function (event) {
     if (disabled || readOnly || plaintext) {
       return;
@@ -219,10 +229,8 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
   }, [onError, onCheck, getFormError]);
   var handleFieldSuccess = useCallback(function (name) {
-    var formError = omit(getFormError(), [name]);
-    setFormError(formError);
-    onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
-  }, [onCheck, getFormError]);
+    removeFieldError(name);
+  }, [removeFieldError]);
   var handleFieldChange = useCallback(function (name, value, event) {
     var _extends5;
 
@@ -244,11 +252,13 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       plaintext: plaintext,
       disabled: disabled,
       formError: getFormError(),
+      removeFieldValue: removeFieldValue,
+      removeFieldError: removeFieldError,
       onFieldChange: handleFieldChange,
       onFieldError: handleFieldError,
       onFieldSuccess: handleFieldSuccess
     };
-  }, [model, checkTrigger, formDefaultValue, errorFromContext, readOnly, plaintext, disabled, getFormError, handleFieldChange, handleFieldError, handleFieldSuccess]);
+  }, [model, checkTrigger, formDefaultValue, errorFromContext, readOnly, plaintext, disabled, getFormError, removeFieldValue, removeFieldError, handleFieldChange, handleFieldError, handleFieldSuccess]);
   return /*#__PURE__*/React.createElement("form", _extends({}, rest, {
     ref: rootRef,
     onSubmit: handleSubmit,

package/esm/Form/FormContext.d.ts

@@ -12,6 +12,8 @@ export interface FormContextValue<T = Record<string, any>, errorMsgType = any, E
     plaintext?: boolean;
     disabled?: boolean;
     formError?: E;
+    removeFieldValue?: (name: string) => void;
+    removeFieldError?: (name: string) => void;
     onFieldChange?: (name: string, value: any, event: React.SyntheticEvent) => void;
     onFieldError?: (name: string, errorMessage: string) => void;
     onFieldSuccess?: (name: string) => void;

package/esm/FormControl/FormControl.d.ts

@@ -28,6 +28,8 @@ export interface FormControlProps<P = any, ValueType = any> extends WithAsProps,
     disabled?: boolean;
     /** Asynchronous check value */
     checkAsync?: boolean;
+    /** Remove field value and error message when component is unmounted  */
+    shouldResetWithUnmount?: boolean;
 }
 interface FormControlComponent extends React.FC<FormControlProps> {
     <Accepter extends React.ElementType = typeof Input>(props: FormControlProps & {

package/esm/FormControl/FormControl.js

@@ -12,6 +12,7 @@ import FormErrorMessage from '../FormErrorMessage';
 import { useClassNames } from '../utils';
 import FormContext, { FormValueContext } from '../Form/FormContext';
 import { FormGroupContext } from '../FormGroup/FormGroup';
+import { useWillUnmount } from '../utils';
 /**
  * Props that FormControl passes to its accepter
  */
@@ -25,6 +26,8 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
       _useContext$formDefau = _useContext.formDefaultValue,
       formDefaultValue = _useContext$formDefau === void 0 ? {} : _useContext$formDefau,
       formError = _useContext.formError,
+      removeFieldValue = _useContext.removeFieldValue,
+      removeFieldError = _useContext.removeFieldError,
       onFieldChange = _useContext.onFieldChange,
       onFieldError = _useContext.onFieldError,
       onFieldSuccess = _useContext.onFieldSuccess,
@@ -54,7 +57,9 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
       onChange = props.onChange,
       onBlur = props.onBlur,
       defaultValue = props.defaultValue,
-      rest = _objectWithoutPropertiesLoose(props, ["as", "accepter", "classPrefix", "className", "checkAsync", "checkTrigger", "errorPlacement", "errorMessage", "name", "value", "readOnly", "plaintext", "disabled", "onChange", "onBlur", "defaultValue"]);
+      _props$shouldResetWit = props.shouldResetWithUnmount,
+      shouldResetWithUnmount = _props$shouldResetWit === void 0 ? false : _props$shouldResetWit,
+      rest = _objectWithoutPropertiesLoose(props, ["as", "accepter", "classPrefix", "className", "checkAsync", "checkTrigger", "errorPlacement", "errorMessage", "name", "value", "readOnly", "plaintext", "disabled", "onChange", "onBlur", "defaultValue", "shouldResetWithUnmount"]);
 
   var _useContext2 = useContext(FormGroupContext),
       controlId = _useContext2.controlId;
@@ -63,6 +68,12 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
     throw new Error("\n      <FormControl> must be inside a component decorated with <Form>.\n      And need to update React to 16.6.0 +.\n    ");
   }
 
+  useWillUnmount(function () {
+    if (shouldResetWithUnmount) {
+      removeFieldValue === null || removeFieldValue === void 0 ? void 0 : removeFieldValue(name);
+      removeFieldError === null || removeFieldError === void 0 ? void 0 : removeFieldError(name);
+    }
+  });
   var trigger = checkTrigger || contextCheckTrigger;
   var formValue = useContext(FormValueContext);
   var val = isUndefined(value) ? formValue === null || formValue === void 0 ? void 0 : formValue[name] : value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsuite",
-  "version": "5.9.0",
+  "version": "5.10.0",
   "description": "A suite of react components",
   "main": "cjs/index.js",
   "module": "esm/index.js",