rsuite 5.49.0 → 5.51.0

package/esm/DateRangePicker/types.d.ts

@@ -9,12 +9,20 @@ export interface RangeType<T = DateRange> {
     placement?: 'bottom' | 'left';
 }
 export declare type DisabledDateFunction = (
-/** Date used to determine if disabling is required. */
+/**
+ * Date used to determine if disabling is required.
+ */
 date: Date, 
-/** Date selected. */
+/**
+ * Date selected.
+ */
 selectDate?: ValueType, 
 /**
  * Whether to choose to finish now.
  * If `false`, only the start date is selected, waiting for the selection end date.
  */
-selectedDone?: boolean, target?: DATERANGE_DISABLED_TARGET) => boolean;
+selectedDone?: boolean, 
+/**
+ * Call the target of the `shouldDisableDate` function.
+ */
+target?: DATERANGE_DISABLED_TARGET) => boolean;

package/esm/DateRangePicker/utils.d.ts

@@ -1,7 +1,8 @@
 import { DateRange } from './types';
-export declare function getSafeCalendarDate({ value, calendarKey }: {
+export declare function getSafeCalendarDate({ value, calendarKey, allowAameMonth }: {
     value: [] | [Date] | [Date, Date] | null;
     calendarKey?: 'start' | 'end';
+    allowAameMonth?: boolean;
 }): DateRange;
 export declare const isSameRange: (source: DateRange | null, dest: DateRange | null, format: string) => boolean;
 export declare const getMonthHoverRange: (date: Date) => DateRange;

package/esm/DateRangePicker/utils.js

@@ -4,29 +4,31 @@ export function getSafeCalendarDate(_ref) {
   var _value;
   var value = _ref.value,
     _ref$calendarKey = _ref.calendarKey,
-    calendarKey = _ref$calendarKey === void 0 ? 'start' : _ref$calendarKey;
+    calendarKey = _ref$calendarKey === void 0 ? 'start' : _ref$calendarKey,
+    allowAameMonth = _ref.allowAameMonth;
   // Update calendarDate if the value is not null
   value = (_value = value) !== null && _value !== void 0 ? _value : [];
+  var gap = allowAameMonth ? 0 : 1;
   if (value[0] && value[1]) {
     var diffMonth = differenceInCalendarMonths(value[1], value[0]);
     if (calendarKey === 'start') {
       return [value[0], diffMonth <= 0 ? copyTime({
         from: value[1],
-        to: addMonths(value[0], 1)
+        to: addMonths(value[0], gap)
       }) : value[1]];
     } else if (calendarKey === 'end') {
       return [diffMonth <= 0 ? copyTime({
         from: value[0],
-        to: addMonths(value[1], -1)
+        to: addMonths(value[1], -gap)
       }) : value[0], value[1]];
     }
 
     // If only the start date
   } else if (value[0]) {
-    return [value[0], addMonths(value[0], 1)];
+    return [value[0], addMonths(value[0], gap)];
   }
   var todayDate = new Date();
-  return [todayDate, addMonths(todayDate, 1)];
+  return [todayDate, addMonths(todayDate, gap)];
 }
 export var isSameRange = function isSameRange(source, dest, format) {
   // If both are null, reguard as same

package/esm/Form/Form.d.ts

@@ -32,6 +32,20 @@ export interface FormProps<T = Record<string, any>, errorMsgType = any, E = {
     disabled?: boolean;
     /** The error message comes from context */
     errorFromContext?: boolean;
+    /**
+     * The form data is nested.
+     * You may now nest fields with "dot syntax" (e.g. address.city).
+     *
+     * @default false
+     * @version v5.51.0
+     * @example
+     * ```jsx
+     * <Form formValue={{ address: { city: 'Shanghai' } }} nestedField>
+     *  <FormControl name="address.city" />
+     * </Form>
+     * ```
+     */
+    nestedField?: boolean;
     /** Callback fired when data changing */
     onChange?: (formValue: T, event?: React.SyntheticEvent) => void;
     /** Callback fired when error checking */

package/esm/Form/Form.js

@@ -1,9 +1,10 @@
 'use client';
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-import React, { useMemo, useCallback, useImperativeHandle, useRef } from 'react';
+import React, { useMemo, useImperativeHandle, useRef } from 'react';
 import PropTypes from 'prop-types';
 import omit from 'lodash/omit';
+import set from 'lodash/set';
 import { SchemaModel } from 'schema-typed';
 import FormContext, { FormValueContext } from './FormContext';
 import FormControl from '../FormControl';
@@ -13,7 +14,7 @@ import FormGroup from '../FormGroup';
 import FormHelpText from '../FormHelpText';
 import { useFormClassNames } from './useFormClassNames';
 import useSchemaModel from './useSchemaModel';
-import { useControlled } from '../utils';
+import { useControlled, useEventCallback } from '../utils';
 /**
  * The `Form` component is a form interface for collecting and validating user input.
  * @see https://rsuitejs.com/components/form
@@ -30,6 +31,8 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     formValue = props.formValue,
     formError = props.formError,
     fluid = props.fluid,
+    _props$nestedField = props.nestedField,
+    nestedField = _props$nestedField === void 0 ? false : _props$nestedField,
     _props$layout = props.layout,
     layout = _props$layout === void 0 ? 'vertical' : _props$layout,
     _props$model = props.model,
@@ -43,7 +46,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     onCheck = props.onCheck,
     onError = props.onError,
     onChange = props.onChange,
-    rest = _objectWithoutPropertiesLoose(props, ["checkTrigger", "classPrefix", "errorFromContext", "formDefaultValue", "formValue", "formError", "fluid", "layout", "model", "readOnly", "plaintext", "className", "children", "disabled", "onSubmit", "onCheck", "onError", "onChange"]);
+    rest = _objectWithoutPropertiesLoose(props, ["checkTrigger", "classPrefix", "errorFromContext", "formDefaultValue", "formValue", "formError", "fluid", "nestedField", "layout", "model", "readOnly", "plaintext", "className", "children", "disabled", "onSubmit", "onCheck", "onError", "onChange"]);
   var _useSchemaModel = useSchemaModel(formModel),
     getCombinedModel = _useSchemaModel.getCombinedModel,
     pushFieldRule = _useSchemaModel.pushFieldRule,
@@ -73,7 +76,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
    * The error message after verification is returned in the callback.
    * @param callback
    */
-  var check = useCallback(function (callback) {
+  var check = useEventCallback(function (callback) {
     var formValue = realFormValue || {};
     var formError = {};
     var errorCount = 0;
@@ -93,14 +96,14 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       return false;
     }
     return true;
-  }, [realFormValue, getCombinedModel, setFormError, onCheck, onError]);
+  });
 
   /**
    * Check the data field
    * @param fieldName
    * @param callback
    */
-  var checkForField = useCallback(function (fieldName, callback) {
+  var checkForField = useEventCallback(function (fieldName, callback) {
     var _extends2;
     var formValue = realFormValue || {};
     var model = getCombinedModel();
@@ -113,12 +116,12 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       onError === null || onError === void 0 ? void 0 : onError(formError);
     }
     return !checkResult.hasError;
-  }, [realFormValue, getCombinedModel, realFormError, setFormError, onCheck, onError]);
+  });
 
   /**
    * Check form data asynchronously and return a Promise
    */
-  var checkAsync = useCallback(function () {
+  var checkAsync = useEventCallback(function () {
     var formValue = realFormValue || {};
     var promises = [];
     var keys = [];
@@ -146,13 +149,13 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
         formError: formError
       };
     });
-  }, [realFormValue, getCombinedModel, onCheck, setFormError, onError]);
+  });
 
   /**
    * Asynchronously check form fields and return Promise
    * @param fieldName
    */
-  var checkForFieldAsync = useCallback(function (fieldName) {
+  var checkForFieldAsync = useEventCallback(function (fieldName) {
     var formValue = realFormValue || {};
     var model = getCombinedModel();
     return model.checkForFieldAsync(fieldName, formValue).then(function (checkResult) {
@@ -165,19 +168,19 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       }
       return checkResult;
     });
-  }, [realFormValue, getCombinedModel, realFormError, onCheck, setFormError, onError]);
-  var cleanErrors = useCallback(function () {
+  });
+  var cleanErrors = useEventCallback(function () {
     setFormError({});
-  }, [setFormError]);
-  var cleanErrorForField = useCallback(function (fieldName) {
+  });
+  var cleanErrorForField = useEventCallback(function (fieldName) {
     setFormError(omit(realFormError, [fieldName]));
-  }, [realFormError, setFormError]);
-  var resetErrors = useCallback(function (formError) {
+  });
+  var resetErrors = useEventCallback(function (formError) {
     if (formError === void 0) {
       formError = {};
     }
     setFormError(formError);
-  }, [setFormError]);
+  });
   useImperativeHandle(ref, function () {
     return {
       root: rootRef.current,
@@ -190,7 +193,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       resetErrors: resetErrors
     };
   });
-  var removeFieldError = useCallback(function (name) {
+  var removeFieldError = useEventCallback(function (name) {
     /**
      * when this function is called when the children component is unmount, it's an old render frame
      * so use Ref to get future error
@@ -199,8 +202,8 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     realFormErrorRef.current = formError;
     setFormError(formError);
     onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
-  }, [onCheck, setFormError]);
-  var removeFieldValue = useCallback(function (name) {
+  });
+  var removeFieldValue = useEventCallback(function (name) {
     /**
      * when this function is called when the children component is unmount, it's an old render frame
      * so use Ref to get future value
@@ -209,8 +212,8 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     realFormValueRef.current = formValue;
     setFormValue(formValue);
     onChange === null || onChange === void 0 ? void 0 : onChange(formValue);
-  }, [onChange, setFormValue]);
-  var handleSubmit = useCallback(function (event) {
+  });
+  var handleSubmit = useEventCallback(function (event) {
     if (disabled || readOnly || plaintext) {
       return;
     }
@@ -218,24 +221,29 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
     event.stopPropagation();
     var checkStatus = check();
     onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(checkStatus, event);
-  }, [disabled, readOnly, plaintext, check, onSubmit]);
-  var handleFieldError = useCallback(function (name, errorMessage) {
+  });
+  var handleFieldError = useEventCallback(function (name, errorMessage) {
     var _extends4;
     var formError = _extends({}, realFormError, (_extends4 = {}, _extends4[name] = errorMessage, _extends4));
     setFormError(formError);
     onError === null || onError === void 0 ? void 0 : onError(formError);
     onCheck === null || onCheck === void 0 ? void 0 : onCheck(formError);
-  }, [realFormError, setFormError, onError, onCheck]);
-  var handleFieldSuccess = useCallback(function (name) {
+  });
+  var handleFieldSuccess = useEventCallback(function (name) {
     removeFieldError(name);
-  }, [removeFieldError]);
-  var handleFieldChange = useCallback(function (name, value, event) {
+  });
+  var setFieldValue = function setFieldValue(formValue, fieldName, fieldValue) {
     var _extends5;
-    var formValue = realFormValue;
-    var nextFormValue = _extends({}, formValue, (_extends5 = {}, _extends5[name] = value, _extends5));
+    if (nestedField) {
+      return set(_extends({}, formValue), fieldName, fieldValue);
+    }
+    return _extends({}, formValue, (_extends5 = {}, _extends5[fieldName] = fieldValue, _extends5));
+  };
+  var handleFieldChange = useEventCallback(function (name, value, event) {
+    var nextFormValue = setFieldValue(realFormValue, name, value);
     setFormValue(nextFormValue);
     onChange === null || onChange === void 0 ? void 0 : onChange(nextFormValue, event);
-  }, [realFormValue, setFormValue, onChange]);
+  });
   var rootRef = useRef(null);
   var formContextValue = useMemo(function () {
     return {
@@ -246,6 +254,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       plaintext: plaintext,
       disabled: disabled,
       formError: realFormError,
+      nestedField: nestedField,
       removeFieldValue: removeFieldValue,
       removeFieldError: removeFieldError,
       pushFieldRule: pushFieldRule,
@@ -254,7 +263,7 @@ var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
       onFieldError: handleFieldError,
       onFieldSuccess: handleFieldSuccess
     };
-  }, [getCombinedModel, checkTrigger, errorFromContext, readOnly, plaintext, disabled, realFormError, removeFieldValue, removeFieldError, pushFieldRule, removeFieldRule, handleFieldChange, handleFieldError, handleFieldSuccess]);
+  }, [getCombinedModel, checkTrigger, errorFromContext, readOnly, plaintext, disabled, realFormError, nestedField, removeFieldValue, removeFieldError, pushFieldRule, removeFieldRule, handleFieldChange, handleFieldError, handleFieldSuccess]);
   return /*#__PURE__*/React.createElement("form", _extends({}, rest, {
     ref: rootRef,
     onSubmit: handleSubmit,

package/esm/Form/FormContext.d.ts

@@ -7,6 +7,7 @@ interface TrulyFormContextValue<T = Record<string, any>, errorMsgType = any, E =
 }> {
     getCombinedModel: () => Schema;
     formError: E;
+    nestedField: boolean;
     removeFieldValue: (name: string) => void;
     removeFieldError: (name: string) => void;
     pushFieldRule: (name: string, fieldRule: FieldRuleType) => void;

package/esm/FormControl/FormControl.d.ts

@@ -9,7 +9,17 @@ export declare type FormControlAccepterProps<ValueType = any> = FormControlBaseP
 export interface FormControlProps<P = any, ValueType = any> extends WithAsProps, Omit<React.HTMLAttributes<HTMLFormElement>, 'value' | 'onChange'> {
     /** Proxied components */
     accepter?: React.ElementType<P & FormControlBaseProps<ValueType>>;
-    /** The name of form-control */
+    /**
+     * The name of form-control, support nested path. such as `address.city`.
+     * The path will be used to get and set form values.
+     *
+     * @example
+     * ```js
+     * <Form formValue={{ address: { city: 'Shanghai' } }}>
+     *   <FormControl name="address.city" />
+     * </Form>
+     * ```
+     **/
     name: string;
     /** Value */
     value?: ValueType;

package/esm/FormControl/FormControl.js

@@ -6,12 +6,14 @@ var _templateObject;
 import React, { useContext } from 'react';
 import PropTypes from 'prop-types';
 import isUndefined from 'lodash/isUndefined';
+import get from 'lodash/get';
+import set from 'lodash/set';
 import Input from '../Input';
 import FormErrorMessage from '../FormErrorMessage';
 import { useClassNames } from '../utils';
 import FormContext, { FormValueContext } from '../Form/FormContext';
 import { FormGroupContext } from '../FormGroup/FormGroup';
-import { useWillUnmount } from '../utils';
+import { useWillUnmount, useEventCallback } from '../utils';
 import useRegisterModel from './useRegisterModel';
 import Toggle from '../Toggle';
 
@@ -31,6 +33,7 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
     disabledContext = _useContext.disabled,
     errorFromContext = _useContext.errorFromContext,
     formError = _useContext.formError,
+    nestedField = _useContext.nestedField,
     removeFieldValue = _useContext.removeFieldValue,
     removeFieldError = _useContext.removeFieldError,
     pushFieldRule = _useContext.pushFieldRule,
@@ -80,47 +83,67 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
   });
   var trigger = checkTrigger || contextCheckTrigger;
   var formValue = useContext(FormValueContext);
-  var val = isUndefined(value) ? formValue === null || formValue === void 0 ? void 0 : formValue[name] : value;
+  var getFieldValue = function getFieldValue(fieldName) {
+    if (!isUndefined(value)) {
+      return value;
+    }
+    return nestedField ? get(formValue, fieldName) : formValue === null || formValue === void 0 ? void 0 : formValue[name];
+  };
+  var setFieldValue = function setFieldValue(fieldName, fieldValue) {
+    var _extends2;
+    if (nestedField) {
+      return set(_extends({}, formValue), fieldName, fieldValue);
+    }
+    return _extends({}, formValue, (_extends2 = {}, _extends2[fieldName] = fieldValue, _extends2));
+  };
+  var getFieldError = function getFieldError(fieldName) {
+    if (nestedField) {
+      var _name = fieldName.includes('.') ? fieldName.replace('.', '.object.') + '.errorMessage' : fieldName;
+      return get(formError, _name);
+    }
+    return formError === null || formError === void 0 ? void 0 : formError[fieldName];
+  };
+  var fieldValue = getFieldValue(name);
   var _useClassNames = useClassNames(classPrefix),
     withClassPrefix = _useClassNames.withClassPrefix,
     prefix = _useClassNames.prefix;
   var classes = withClassPrefix('wrapper');
-  var handleFieldChange = function handleFieldChange(value, event) {
+  var handleFieldChange = useEventCallback(function (value, event) {
     handleFieldCheck(value, trigger === 'change');
     onFieldChange === null || onFieldChange === void 0 ? void 0 : onFieldChange(name, value, event);
     onChange === null || onChange === void 0 ? void 0 : onChange(value, event);
-  };
-  var handleFieldBlur = function handleFieldBlur(event) {
-    handleFieldCheck(val, trigger === 'blur');
+  });
+  var handleFieldBlur = useEventCallback(function (event) {
+    handleFieldCheck(fieldValue, trigger === 'blur');
     onBlur === null || onBlur === void 0 ? void 0 : onBlur(event);
-  };
-  var handleFieldCheck = function handleFieldCheck(value, isCheckTrigger) {
-    var _extends2;
+  });
+  var handleFieldCheck = useEventCallback(function (value, isCheckTrigger) {
+    var checkFieldName = nestedField ? name.split('.')[0] : name;
     var callbackEvents = function callbackEvents(checkResult) {
       // The relevant event is triggered only when the inspection is allowed.
       if (isCheckTrigger) {
         if (checkResult.hasError) {
-          onFieldError === null || onFieldError === void 0 ? void 0 : onFieldError(name, (checkResult === null || checkResult === void 0 ? void 0 : checkResult.errorMessage) || checkResult);
+          onFieldError === null || onFieldError === void 0 ? void 0 : onFieldError(checkFieldName, (checkResult === null || checkResult === void 0 ? void 0 : checkResult.errorMessage) || checkResult);
         } else {
-          onFieldSuccess === null || onFieldSuccess === void 0 ? void 0 : onFieldSuccess(name);
+          onFieldSuccess === null || onFieldSuccess === void 0 ? void 0 : onFieldSuccess(checkFieldName);
         }
       }
       return checkResult;
     };
-    var nextFormValue = _extends({}, formValue, (_extends2 = {}, _extends2[name] = value, _extends2));
+    var nextFormValue = setFieldValue(name, value);
     var model = getCombinedModel();
     if (checkAsync) {
-      return model === null || model === void 0 ? void 0 : model.checkForFieldAsync(name, nextFormValue).then(function (checkResult) {
+      return model === null || model === void 0 ? void 0 : model.checkForFieldAsync(checkFieldName, nextFormValue).then(function (checkResult) {
         return callbackEvents(checkResult);
       });
     }
-    return Promise.resolve(callbackEvents(model === null || model === void 0 ? void 0 : model.checkForField(name, nextFormValue)));
-  };
+    return Promise.resolve(callbackEvents(model === null || model === void 0 ? void 0 : model.checkForField(checkFieldName, nextFormValue)));
+  });
   var messageNode = null;
   if (!isUndefined(errorMessage)) {
     messageNode = errorMessage;
   } else if (errorFromContext) {
-    var fieldError = formError === null || formError === void 0 ? void 0 : formError[name];
+    var fieldError = getFieldError(name);
     if (typeof fieldError === 'string' || !(fieldError !== null && fieldError !== void 0 && fieldError.array) && !(fieldError !== null && fieldError !== void 0 && fieldError.object) && fieldError !== null && fieldError !== void 0 && fieldError.hasError) {
       messageNode = fieldError;
     }
@@ -134,7 +157,7 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
   if (AccepterComponent === Toggle) {
     valueKey = 'checked';
   }
-  var accepterProps = (_accepterProps = {}, _accepterProps[valueKey] = val === undefined ? defaultValue : val, _accepterProps);
+  var accepterProps = (_accepterProps = {}, _accepterProps[valueKey] = fieldValue === undefined ? defaultValue : fieldValue, _accepterProps);
   return /*#__PURE__*/React.createElement(Component, {
     className: classes,
     ref: ref,
@@ -153,7 +176,7 @@ var FormControl = /*#__PURE__*/React.forwardRef(function (props, ref) {
     onChange: handleFieldChange,
     onBlur: handleFieldBlur
   })), /*#__PURE__*/React.createElement(FormErrorMessage, {
-    id: controlId + "-error-message",
+    id: controlId ? controlId + "-error-message" : undefined,
     role: "alert",
     "aria-relevant": "all",
     show: !!messageNode,

package/esm/FormGroup/FormGroup.js

@@ -3,7 +3,7 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
-import { useClassNames } from '../utils';
+import { useClassNames, useUniqueId } from '../utils';
 export var FormGroupContext = /*#__PURE__*/React.createContext({});
 
 /**
@@ -15,13 +15,14 @@ var FormGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
     Component = _props$as === void 0 ? 'div' : _props$as,
     _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'form-group' : _props$classPrefix,
-    controlId = props.controlId,
+    controlIdProp = props.controlId,
     className = props.className,
     rest = _objectWithoutPropertiesLoose(props, ["as", "classPrefix", "controlId", "className"]);
   var _useClassNames = useClassNames(classPrefix),
     withClassPrefix = _useClassNames.withClassPrefix,
     merge = _useClassNames.merge;
   var classes = merge(className, withClassPrefix());
+  var controlId = useUniqueId('rs-', controlIdProp);
   var contextValue = useMemo(function () {
     return {
       controlId: controlId