rsuite 5.59.1 → 5.59.3-alpha.1

package/esm/FormGroup/index.d.ts

@@ -1,3 +1,4 @@
 import FormGroup from './FormGroup';
 export type { FormGroupProps } from './FormGroup';
+export { useFormGroup } from './FormGroup';
 export default FormGroup;

package/esm/FormGroup/index.js

@@ -1,3 +1,4 @@
 'use client';
 import FormGroup from './FormGroup';
+export { useFormGroup } from './FormGroup';
 export default FormGroup;

package/esm/FormHelpText/FormHelpText.d.ts

@@ -1,5 +1,6 @@
+import React from 'react';
 import { WithAsProps, RsRefForwardingComponent } from '../@types/common';
-export interface FormHelpTextProps extends WithAsProps {
+export interface FormHelpTextProps extends WithAsProps, React.HTMLAttributes<HTMLSpanElement> {
     /** Whether to show through the Tooltip component */
     tooltip?: boolean;
 }

package/esm/FormHelpText/FormHelpText.js

@@ -1,18 +1,20 @@
 'use client';
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-import React, { useContext } from 'react';
+import React from 'react';
 import PropTypes from 'prop-types';
 import Tooltip from '../Tooltip';
 import Whisper from '../Whisper';
 import { useClassNames } from '../utils';
-import { FormGroupContext } from '../FormGroup/FormGroup';
-import HelpO from '@rsuite/icons/legacy/HelpO';
+import { useFormGroup } from '../FormGroup';
+import HelpIcon from '@rsuite/icons/legacy/HelpO';
 /**
  * The `<Form.HelpText>` component is used to display help information in the form.
  * @see https://rsuitejs.com/components/form/
  */
 var FormHelpText = /*#__PURE__*/React.forwardRef(function (props, ref) {
+  var _useFormGroup = useFormGroup(),
+    helpTextId = _useFormGroup.helpTextId;
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,
     _props$classPrefix = props.classPrefix,
@@ -20,9 +22,9 @@ var FormHelpText = /*#__PURE__*/React.forwardRef(function (props, ref) {
     className = props.className,
     tooltip = props.tooltip,
     children = props.children,
-    rest = _objectWithoutPropertiesLoose(props, ["as", "classPrefix", "className", "tooltip", "children"]);
-  var _useContext = useContext(FormGroupContext),
-    controlId = _useContext.controlId;
+    _props$id = props.id,
+    id = _props$id === void 0 ? helpTextId : _props$id,
+    rest = _objectWithoutPropertiesLoose(props, ["as", "classPrefix", "className", "tooltip", "children", "id"]);
   var _useClassNames = useClassNames(classPrefix),
     withClassPrefix = _useClassNames.withClassPrefix,
     merge = _useClassNames.merge;
@@ -33,13 +35,19 @@ var FormHelpText = /*#__PURE__*/React.forwardRef(function (props, ref) {
     return /*#__PURE__*/React.createElement(Whisper, {
       ref: ref,
       placement: "topEnd",
-      speaker: /*#__PURE__*/React.createElement(Tooltip, rest, children)
+      speaker: /*#__PURE__*/React.createElement(Tooltip, _extends({
+        id: id
+      }, rest), children)
     }, /*#__PURE__*/React.createElement(Component, {
+      role: "img",
+      "aria-label": "help",
       className: classes
-    }, /*#__PURE__*/React.createElement(HelpO, null)));
+    }, /*#__PURE__*/React.createElement(HelpIcon, {
+      "aria-hidden": true
+    })));
   }
   return /*#__PURE__*/React.createElement(Component, _extends({
-    id: controlId ? controlId + "-help-text" : null
+    id: id
   }, rest, {
     ref: ref,
     className: classes

package/esm/Input/Input.js

@@ -3,7 +3,7 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import React, { useContext } from 'react';
 import PropTypes from 'prop-types';
-import { FormGroupContext } from '../FormGroup/FormGroup';
+import { useFormGroup } from '../FormGroup';
 import { InputGroupContext } from '../InputGroup/InputGroup';
 import Plaintext from '../internals/Plaintext';
 import { createChainedFunction, mergeRefs, useClassNames, KEY_VALUES } from '../utils';
@@ -54,9 +54,8 @@ var Input = /*#__PURE__*/React.forwardRef(function (props, ref) {
     plaintext: plaintext
   }));
   var inputGroupContext = useContext(InputGroupContext);
-  var formGroupContext = useContext(FormGroupContext);
-
-  // Make the Input component display in plain text,
+  var _useFormGroup = useFormGroup(),
+    controlId = _useFormGroup.controlId; // Make the Input component display in plain text,
   // and display default characters when there is no value.
   if (plaintext) {
     return /*#__PURE__*/React.createElement(Plaintext, {
@@ -77,7 +76,7 @@ var Input = /*#__PURE__*/React.forwardRef(function (props, ref) {
     ref: mergeRefs(ref, inputRef),
     className: classes,
     type: type,
-    id: id || (formGroupContext === null || formGroupContext === void 0 ? void 0 : formGroupContext.controlId),
+    id: id || controlId,
     value: value,
     defaultValue: defaultValue,
     disabled: disabled,

package/esm/utils/dateUtils.d.ts

@@ -43,28 +43,84 @@ export { default as set } from 'date-fns/set';
 export { default as differenceInCalendarMonths } from 'date-fns/differenceInCalendarMonths';
 export { default as isLastDayOfMonth } from 'date-fns/isLastDayOfMonth';
 export { default as lastDayOfMonth } from 'date-fns/lastDayOfMonth';
-export declare type CalendarOnlyPropsType = 'disabledHours' | 'disabledMinutes' | 'disabledSeconds' | 'hideHours' | 'hideMinutes' | 'hideSeconds';
-export declare const calendarOnlyProps: CalendarOnlyPropsType[];
+declare enum TimeProp {
+    DisabledHours = "disabledHours",
+    DisabledMinutes = "disabledMinutes",
+    DisabledSeconds = "disabledSeconds",
+    ShouldDisableHour = "shouldDisableHour",
+    ShouldDisableMinute = "shouldDisableMinute",
+    ShouldDisableSecond = "shouldDisableSecond",
+    HideHours = "hideHours",
+    HideMinutes = "hideMinutes",
+    HideSeconds = "hideSeconds"
+}
+export declare type CalendarOnlyPropsType = TimeProp;
+export declare const calendarOnlyProps: readonly [TimeProp.DisabledHours, TimeProp.DisabledMinutes, TimeProp.DisabledSeconds, TimeProp.HideHours, TimeProp.HideMinutes, TimeProp.HideSeconds];
+interface CalendarProps {
+    [TimeProp.DisabledHours]?: (hours: number, date: Date) => boolean;
+    [TimeProp.DisabledMinutes]?: (minutes: number, date: Date) => boolean;
+    [TimeProp.DisabledSeconds]?: (seconds: number, date: Date) => boolean;
+    [TimeProp.HideHours]?: (hours: number, date: Date) => boolean;
+    [TimeProp.HideMinutes]?: (minutes: number, date: Date) => boolean;
+    [TimeProp.HideSeconds]?: (seconds: number, date: Date) => boolean;
+}
 /**
  * Verify that the time is valid.
  *
- * @param props
- * @param date
+ * @param props - The calendar props.
+ * @param date - The date to check.
+ * @returns Whether the time is disabled.
+ */
+export declare function disableTime(props: CalendarProps, date: Date): boolean;
+/**
+ * Omit the calendar-only props from an object.
+ *
+ * @param props - The object to omit props from.
+ * @returns The object with calendar-only props omitted.
+ */
+export declare const omitHideDisabledProps: <T extends Record<string, any>>(props: T) => Partial<Omit<T, TimeProp>>;
+/**
+ * Check if the time should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether the time should be rendered.
  */
-export declare function disabledTime(props: any, date: Date): boolean;
-export declare const omitHideDisabledProps: <T extends Record<string, any>>(props: T) => Partial<Omit<T, CalendarOnlyPropsType>>;
 export declare const shouldRenderTime: (format: string) => boolean;
+/**
+ * Check if the month should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether the month should be rendered.
+ */
 export declare const shouldRenderMonth: (format: string) => boolean;
+/**
+ * Check if the date should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether the date should be rendered.
+ */
 export declare const shouldRenderDate: (format: string) => boolean;
+/**
+ * Check if only the time should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether only the time should be rendered.
+ */
 export declare const shouldOnlyRenderTime: (format: string) => boolean;
 /**
- * Get all weeks of this month
- * @params monthDate
- * @return date[]
+ * Get all weeks of a month.
+ *
+ * @param monthDate - The date of the month.
+ * @param isoWeek - Whether to use ISO week numbering.
+ * @returns An array of weeks in the month.
  */
 export declare function getMonthView(monthDate: Date, isoWeek: boolean): Date[];
 /**
- * Copy the time of one date to another
+ * Copy the time from one date to another.
+ *
+ * @param from - The source date.
+ * @param to - The target date.
+ * @returns The target date with the time copied from the source date.
  */
 export declare function copyTime({ from, to }: {
     from: Date;
@@ -72,9 +128,15 @@ export declare function copyTime({ from, to }: {
 }): Date;
 /**
  * Swap two dates without swapping the time.
+ *
+ * @param dateRange - The date range to reverse.
+ * @returns The reversed date range.
  */
 export declare function reverseDateRangeOmitTime(dateRange: [Date, Date]): [Date, Date];
 /**
  * Get the time with AM and PM reversed.
+ *
+ * @param date - The date to reverse the time meridian.
+ * @returns The date with the time meridian reversed.
  */
 export declare const getReversedTimeMeridian: (date: Date) => Date;

package/esm/utils/dateUtils.js

@@ -54,63 +54,111 @@ export { default as set } from 'date-fns/set';
 export { default as differenceInCalendarMonths } from 'date-fns/differenceInCalendarMonths';
 export { default as isLastDayOfMonth } from 'date-fns/isLastDayOfMonth';
 export { default as lastDayOfMonth } from 'date-fns/lastDayOfMonth';
-var disabledTimeProps = ['disabledHours', 'disabledMinutes', 'disabledSeconds'];
-var hideTimeProps = ['hideHours', 'hideMinutes', 'hideSeconds'];
-export var calendarOnlyProps = disabledTimeProps.concat(hideTimeProps);
-function validTime(calendarProps, date) {
+var TimeProp;
+(function (TimeProp) {
+  TimeProp["DisabledHours"] = "disabledHours";
+  TimeProp["DisabledMinutes"] = "disabledMinutes";
+  TimeProp["DisabledSeconds"] = "disabledSeconds";
+  TimeProp["ShouldDisableHour"] = "shouldDisableHour";
+  TimeProp["ShouldDisableMinute"] = "shouldDisableMinute";
+  TimeProp["ShouldDisableSecond"] = "shouldDisableSecond";
+  TimeProp["HideHours"] = "hideHours";
+  TimeProp["HideMinutes"] = "hideMinutes";
+  TimeProp["HideSeconds"] = "hideSeconds";
+})(TimeProp || (TimeProp = {}));
+export var calendarOnlyProps = [TimeProp.DisabledHours, TimeProp.DisabledMinutes, TimeProp.DisabledSeconds, TimeProp.HideHours, TimeProp.HideMinutes, TimeProp.HideSeconds];
+var HOURS_PATTERN = /(Hours?)/;
+var MINUTES_PATTERN = /(Minutes?)/;
+var SECONDS_PATTERN = /(Seconds?)/;
+/**
+ * Verify that the time is valid.
+ *
+ * @param props - The calendar props.
+ * @param date - The date to check.
+ * @returns Whether the time is disabled.
+ */
+export function disableTime(props, date) {
   if (!date) {
     return false;
   }
-  return Object.keys(calendarProps).some(function (key) {
-    if (/(Hours)/.test(key)) {
-      var _calendarProps$key;
-      return (_calendarProps$key = calendarProps[key]) === null || _calendarProps$key === void 0 ? void 0 : _calendarProps$key.call(calendarProps, getHours(date), date);
+  var disabledTimeProps = [TimeProp.DisabledHours, TimeProp.DisabledMinutes, TimeProp.DisabledSeconds, TimeProp.ShouldDisableHour, TimeProp.ShouldDisableMinute, TimeProp.ShouldDisableSecond];
+  var calendarProps = pick(props, disabledTimeProps);
+  var mapProps = new Map(Object.entries(calendarProps));
+  return Array.from(mapProps.keys()).some(function (key) {
+    if (HOURS_PATTERN.test(key)) {
+      var _mapProps$get;
+      return (_mapProps$get = mapProps.get(key)) === null || _mapProps$get === void 0 ? void 0 : _mapProps$get(getHours(date), date);
     }
-    if (/(Minutes)/.test(key)) {
-      var _calendarProps$key2;
-      return (_calendarProps$key2 = calendarProps[key]) === null || _calendarProps$key2 === void 0 ? void 0 : _calendarProps$key2.call(calendarProps, getMinutes(date), date);
+    if (MINUTES_PATTERN.test(key)) {
+      var _mapProps$get2;
+      return (_mapProps$get2 = mapProps.get(key)) === null || _mapProps$get2 === void 0 ? void 0 : _mapProps$get2(getMinutes(date), date);
     }
-    if (/(Seconds)/.test(key)) {
-      var _calendarProps$key3;
-      return (_calendarProps$key3 = calendarProps[key]) === null || _calendarProps$key3 === void 0 ? void 0 : _calendarProps$key3.call(calendarProps, getSeconds(date), date);
+    if (SECONDS_PATTERN.test(key)) {
+      var _mapProps$get3;
+      return (_mapProps$get3 = mapProps.get(key)) === null || _mapProps$get3 === void 0 ? void 0 : _mapProps$get3(getSeconds(date), date);
     }
     return false;
   });
 }
 
 /**
- * Verify that the time is valid.
+ * Omit the calendar-only props from an object.
  *
- * @param props
- * @param date
+ * @param props - The object to omit props from.
+ * @returns The object with calendar-only props omitted.
  */
-export function disabledTime(props, date) {
-  var calendarProps = pick(props, disabledTimeProps);
-  return validTime(calendarProps, date);
-}
 export var omitHideDisabledProps = function omitHideDisabledProps(props) {
   return omitBy(props, function (_val, key) {
-    return key.startsWith('disabled') || key.startsWith('hide');
+    return key.startsWith('disabled') || key.startsWith('hide') || key.startsWith('shouldDisable');
   });
 };
+
+/**
+ * Check if the time should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether the time should be rendered.
+ */
 export var shouldRenderTime = function shouldRenderTime(format) {
   return /([Hhms])/.test(format);
 };
+
+/**
+ * Check if the month should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether the month should be rendered.
+ */
 export var shouldRenderMonth = function shouldRenderMonth(format) {
   return /[Yy]/.test(format) && /[ML]/.test(format);
 };
+
+/**
+ * Check if the date should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether the date should be rendered.
+ */
 export var shouldRenderDate = function shouldRenderDate(format) {
   return /[Yy]/.test(format) && /[ML]/.test(format) && /[Dd]/.test(format);
-}; // for date-fns v1 and v2
+};
 
+/**
+ * Check if only the time should be rendered based on the format.
+ *
+ * @param format - The format string.
+ * @returns Whether only the time should be rendered.
+ */
 export var shouldOnlyRenderTime = function shouldOnlyRenderTime(format) {
   return /([Hhms])/.test(format) && !/([YyMDd])/.test(format);
-}; // for date-fns v1 and v2
+};
 
 /**
- * Get all weeks of this month
- * @params monthDate
- * @return date[]
+ * Get all weeks of a month.
+ *
+ * @param monthDate - The date of the month.
+ * @param isoWeek - Whether to use ISO week numbering.
+ * @returns An array of weeks in the month.
  */
 export function getMonthView(monthDate, isoWeek) {
   var firstDayOfMonth = getDay(monthDate);
@@ -133,7 +181,11 @@ export function getMonthView(monthDate, isoWeek) {
 }
 
 /**
- * Copy the time of one date to another
+ * Copy the time from one date to another.
+ *
+ * @param from - The source date.
+ * @param to - The target date.
+ * @returns The target date with the time copied from the source date.
  */
 export function copyTime(_ref) {
   var from = _ref.from,
@@ -150,6 +202,9 @@ export function copyTime(_ref) {
 
 /**
  * Swap two dates without swapping the time.
+ *
+ * @param dateRange - The date range to reverse.
+ * @returns The reversed date range.
  */
 export function reverseDateRangeOmitTime(dateRange) {
   var start = dateRange[0],
@@ -168,6 +223,9 @@ export function reverseDateRangeOmitTime(dateRange) {
 
 /**
  * Get the time with AM and PM reversed.
+ *
+ * @param date - The date to reverse the time meridian.
+ * @returns The date with the time meridian reversed.
  */
 export var getReversedTimeMeridian = function getReversedTimeMeridian(date) {
   var clonedDate = new Date(date.valueOf());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsuite",
-  "version": "5.59.1",
+  "version": "5.59.3-alpha.1",
   "description": "A suite of react components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -39,7 +39,7 @@
     "react-use-set": "^1.0.0",
     "react-window": "^1.8.8",
     "rsuite-table": "^5.18.2",
-    "schema-typed": "^2.2.1"
+    "schema-typed": "^2.2.2"
   },
   "peerDependencies": {
     "react": ">=16.8.0",

package/cjs/Form/hooks/useFormError.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="lodash" />
-export default function useFormError(formError: any): {
-    formError: any;
-    setFormError: (value: any) => void;
-    onRemoveError: (name: string) => import("lodash").Omit<any, string>;
-};

package/cjs/Form/hooks/useFormError.js

@@ -1,31 +0,0 @@
-'use client';
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-exports.__esModule = true;
-exports.default = useFormError;
-var _react = require("react");
-var _omit = _interopRequireDefault(require("lodash/omit"));
-var _utils = require("../../utils");
-function useFormError(formError) {
-  var _useControlled = (0, _utils.useControlled)(formError, {}),
-    realFormError = _useControlled[0],
-    setFormError = _useControlled[1];
-  var realFormErrorRef = (0, _react.useRef)(realFormError);
-  realFormErrorRef.current = realFormError;
-  var onRemoveError = (0, _react.useCallback)(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
-     */
-    var formError = (0, _omit.default)(realFormErrorRef.current, [name]);
-    realFormErrorRef.current = formError;
-    setFormError(formError);
-    return formError;
-  }, [setFormError]);
-  return {
-    formError: realFormError,
-    setFormError: setFormError,
-    onRemoveError: onRemoveError
-  };
-}

package/cjs/FormControl/useRegisterModel.d.ts

@@ -1,4 +0,0 @@
-import type { FieldRuleType } from '../Form/hooks/useSchemaModel';
-import type { CheckType } from 'schema-typed';
-declare function useRegisterModel(name: string, pushFieldRule: (n: string, r: FieldRuleType) => void, removeFieldRule: (n: string) => void, rule?: CheckType<unknown, any>): void;
-export default useRegisterModel;

package/cjs/FormControl/useRegisterModel.js

@@ -1,18 +0,0 @@
-'use client';
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _react = require("react");
-function useRegisterModel(name, pushFieldRule, removeFieldRule, rule) {
-  var refRule = (0, _react.useRef)(rule);
-  refRule.current = rule;
-  (0, _react.useEffect)(function () {
-    pushFieldRule(name, refRule);
-    return function () {
-      removeFieldRule(name);
-    };
-  }, [name, pushFieldRule, removeFieldRule]);
-}
-var _default = useRegisterModel;
-exports.default = _default;

package/esm/Form/hooks/useFormError.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="lodash" />
-export default function useFormError(formError: any): {
-    formError: any;
-    setFormError: (value: any) => void;
-    onRemoveError: (name: string) => import("lodash").Omit<any, string>;
-};

package/esm/Form/hooks/useFormError.js

@@ -1,26 +0,0 @@
-'use client';
-import { useRef, useCallback } from 'react';
-import omit from 'lodash/omit';
-import { useControlled } from '../../utils';
-export default function useFormError(formError) {
-  var _useControlled = useControlled(formError, {}),
-    realFormError = _useControlled[0],
-    setFormError = _useControlled[1];
-  var realFormErrorRef = useRef(realFormError);
-  realFormErrorRef.current = realFormError;
-  var onRemoveError = useCallback(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
-     */
-    var formError = omit(realFormErrorRef.current, [name]);
-    realFormErrorRef.current = formError;
-    setFormError(formError);
-    return formError;
-  }, [setFormError]);
-  return {
-    formError: realFormError,
-    setFormError: setFormError,
-    onRemoveError: onRemoveError
-  };
-}

package/esm/FormControl/useRegisterModel.d.ts

@@ -1,4 +0,0 @@
-import type { FieldRuleType } from '../Form/hooks/useSchemaModel';
-import type { CheckType } from 'schema-typed';
-declare function useRegisterModel(name: string, pushFieldRule: (n: string, r: FieldRuleType) => void, removeFieldRule: (n: string) => void, rule?: CheckType<unknown, any>): void;
-export default useRegisterModel;

package/esm/FormControl/useRegisterModel.js

@@ -1,13 +0,0 @@
-'use client';
-import { useRef, useEffect } from 'react';
-function useRegisterModel(name, pushFieldRule, removeFieldRule, rule) {
-  var refRule = useRef(rule);
-  refRule.current = rule;
-  useEffect(function () {
-    pushFieldRule(name, refRule);
-    return function () {
-      removeFieldRule(name);
-    };
-  }, [name, pushFieldRule, removeFieldRule]);
-}
-export default useRegisterModel;