rsuite 5.59.0 → 5.59.2

package/esm/FormControlLabel/FormControlLabel.js

@@ -1,31 +1,35 @@
 '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 { useClassNames } from '../utils';
-import { FormGroupContext } from '../FormGroup/FormGroup';
+import { useFormGroup } from '../FormGroup';
 /**
  * The `<Form.ControlLabel>` component renders a label with required indicator, for form controls.
  * @see https://rsuitejs.com/components/form/
  */
 var FormControlLabel = /*#__PURE__*/React.forwardRef(function (props, ref) {
+  var _useFormGroup = useFormGroup(),
+    labelId = _useFormGroup.labelId,
+    controlId = _useFormGroup.controlId;
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'label' : _props$as,
     _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'form-control-label' : _props$classPrefix,
-    htmlFor = props.htmlFor,
+    _props$htmlFor = props.htmlFor,
+    htmlFor = _props$htmlFor === void 0 ? controlId : _props$htmlFor,
     className = props.className,
-    rest = _objectWithoutPropertiesLoose(props, ["as", "classPrefix", "htmlFor", "className"]);
-  var _useContext = useContext(FormGroupContext),
-    controlId = _useContext.controlId;
+    _props$id = props.id,
+    id = _props$id === void 0 ? labelId : _props$id,
+    rest = _objectWithoutPropertiesLoose(props, ["as", "classPrefix", "htmlFor", "className", "id"]);
   var _useClassNames = useClassNames(classPrefix),
     withClassPrefix = _useClassNames.withClassPrefix,
     merge = _useClassNames.merge;
   var classes = merge(className, withClassPrefix());
   return /*#__PURE__*/React.createElement(Component, _extends({
-    id: controlId ? controlId + "-control-label" : null,
-    htmlFor: htmlFor || controlId
+    id: id,
+    htmlFor: htmlFor
   }, rest, {
     ref: ref,
     className: classes

package/esm/FormErrorMessage/FormErrorMessage.js

@@ -29,10 +29,7 @@ var FormErrorMessage = /*#__PURE__*/React.forwardRef(function (props, ref) {
     merge = _useClassNames.merge;
   var classes = withClassPrefix('show');
   var wrapperClasses = merge(className, prefix('wrapper', (_prefix = {}, _prefix["placement-" + kebabCase(placementPolyfill(placement))] = placement, _prefix)));
-  if (!show) {
-    return null;
-  }
-  return /*#__PURE__*/React.createElement(Component, _extends({}, rest, {
+  return show ? /*#__PURE__*/React.createElement(Component, _extends({}, rest, {
     ref: ref,
     className: wrapperClasses
   }), /*#__PURE__*/React.createElement("span", {
@@ -41,7 +38,7 @@ var FormErrorMessage = /*#__PURE__*/React.forwardRef(function (props, ref) {
     className: prefix(_templateObject || (_templateObject = _taggedTemplateLiteralLoose(["arrow"])))
   }), /*#__PURE__*/React.createElement("span", {
     className: prefix(_templateObject2 || (_templateObject2 = _taggedTemplateLiteralLoose(["inner"])))
-  }, children)));
+  }, children))) : null;
 });
 FormErrorMessage.displayName = 'FormErrorMessage';
 FormErrorMessage.propTypes = {

package/esm/FormGroup/FormGroup.d.ts

@@ -1,4 +1,3 @@
-import React from 'react';
 import { WithAsProps, RsRefForwardingComponent } from '../@types/common';
 export interface FormGroupProps extends WithAsProps {
     /**
@@ -7,9 +6,24 @@ export interface FormGroupProps extends WithAsProps {
      */
     controlId?: string;
 }
-export declare const FormGroupContext: React.Context<{
-    controlId?: string | undefined;
-}>;
+export declare const useFormGroup: (controlId?: string) => {
+    /**
+     * The `id` of the `<Form.Control>` component.
+     */
+    controlId: string;
+    /**
+     * The `id` of the `<Form.HelpText>` component.
+     */
+    helpTextId: string;
+    /**
+     * The `id` of the `<Form.ControlLabel>` component.
+     */
+    labelId: string;
+    /**
+     * The `id` of the `<Form.ErrorMessage>` component.
+     */
+    errorMessageId: string;
+};
 /**
  * The `<Form.Group>` component is the easiest way to add some structure to forms.
  * @see https://rsuitejs.com/components/form/

package/esm/FormGroup/FormGroup.js

@@ -4,7 +4,33 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames, useUniqueId } from '../utils';
-export var FormGroupContext = /*#__PURE__*/React.createContext({});
+var FormGroupContext = /*#__PURE__*/React.createContext({});
+export var useFormGroup = function useFormGroup(controlId) {
+  var context = React.useContext(FormGroupContext);
+  var fallbackId = useUniqueId('rs-');
+  var id = controlId || context.controlId || fallbackId;
+  var helpTextId = id + "-help-text";
+  var labelId = id + "-label";
+  var errorMessageId = id + "-error-message";
+  return {
+    /**
+     * The `id` of the `<Form.Control>` component.
+     */
+    controlId: id,
+    /**
+     * The `id` of the `<Form.HelpText>` component.
+     */
+    helpTextId: helpTextId,
+    /**
+     * The `id` of the `<Form.ControlLabel>` component.
+     */
+    labelId: labelId,
+    /**
+     * The `id` of the `<Form.ErrorMessage>` component.
+     */
+    errorMessageId: errorMessageId
+  };
+};
 
 /**
  * The `<Form.Group>` component is the easiest way to add some structure to forms.

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/Placeholder/PlaceholderGraph.d.ts

@@ -1,8 +1,20 @@
 import { WithAsProps, RsRefForwardingComponent } from '../@types/common';
 export interface PlaceholderGraphProps extends WithAsProps {
+    /**
+     * The height of the graph.
+     *
+     * @default 200
+     */
     height?: number;
+    /**
+     * The width of the graph.
+     *
+     * @default 100%
+     */
     width?: number;
-    /** Placeholder status */
+    /**
+     * Placeholder status, display the loading state.
+     */
     active?: boolean;
 }
 /**

package/esm/Placeholder/PlaceholderGrid.d.ts

@@ -1,10 +1,36 @@
 import { WithAsProps, RsRefForwardingComponent } from '../@types/common';
 export interface PlaceholderGridProps extends WithAsProps {
+    /**
+     * The number of rows.
+     *
+     * @default 5
+     */
     rows?: number;
+    /**
+     * The height of the row.
+     *
+     * @default 10
+     */
     rowHeight?: number;
+    /**
+     * @deprecated Use `rowSpacing` instead.
+     */
     rowMargin?: number;
+    /**
+     * The spacing between rows.
+     *
+     * @default 20
+     * @version 5.59.1
+     */
+    rowSpacing?: number;
+    /**
+     * The number of columns.
+     * @default 5
+     */
     columns?: number;
-    /** Placeholder status */
+    /**
+     * Placeholder status, display the loading state.
+     */
     active?: boolean;
 }
 /**

package/esm/Placeholder/PlaceholderGrid.js

@@ -1,6 +1,8 @@
 'use client';
 import _extends from "@babel/runtime/helpers/esm/extends";
+import _taggedTemplateLiteralLoose from "@babel/runtime/helpers/esm/taggedTemplateLiteralLoose";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+var _templateObject;
 import React from 'react';
 import PropTypes from 'prop-types';
 import classNames from 'classnames';
@@ -23,8 +25,10 @@ var PlaceholderGrid = /*#__PURE__*/React.forwardRef(function (props, ref) {
     rowHeight = _props$rowHeight === void 0 ? 10 : _props$rowHeight,
     _props$rowMargin = props.rowMargin,
     rowMargin = _props$rowMargin === void 0 ? 20 : _props$rowMargin,
+    _props$rowSpacing = props.rowSpacing,
+    rowSpacing = _props$rowSpacing === void 0 ? rowMargin : _props$rowSpacing,
     active = props.active,
-    rest = _objectWithoutPropertiesLoose(props, ["as", "className", "classPrefix", "rows", "columns", "rowHeight", "rowMargin", "active"]);
+    rest = _objectWithoutPropertiesLoose(props, ["as", "className", "classPrefix", "rows", "columns", "rowHeight", "rowMargin", "rowSpacing", "active"]);
   var _useClassNames = useClassNames(classPrefix),
     merge = _useClassNames.merge,
     prefix = _useClassNames.prefix,
@@ -33,23 +37,16 @@ var PlaceholderGrid = /*#__PURE__*/React.forwardRef(function (props, ref) {
     active: active
   }));
   var colItems = [];
-  var firstRowItemWidth = Math.random() * 30 + 30;
-  var itemWidth = firstRowItemWidth / 2;
   for (var i = 0; i < columns; i++) {
     var rowItems = [];
     for (var j = 0; j < rows; j++) {
-      var widthPercent = Math.random() * 50 + 10; // when first column
-      if (i > 0) {
-        // when other columns
-        widthPercent = j > 0 ? itemWidth : firstRowItemWidth;
-      }
-      rowItems.push( /*#__PURE__*/React.createElement("p", {
+      rowItems.push( /*#__PURE__*/React.createElement("div", {
         key: j,
         style: {
-          width: widthPercent + "%",
           height: rowHeight,
-          marginTop: j > 0 ? rowMargin : undefined
-        }
+          marginTop: j > 0 ? rowSpacing : undefined
+        },
+        className: prefix(_templateObject || (_templateObject = _taggedTemplateLiteralLoose(["row"])))
       }));
     }
     colItems.push( /*#__PURE__*/React.createElement("div", {
@@ -69,7 +66,7 @@ PlaceholderGrid.propTypes = {
   rows: PropTypes.number,
   columns: PropTypes.number,
   rowHeight: PropTypes.number,
-  rowMargin: PropTypes.number,
+  rowSpacing: PropTypes.number,
   active: PropTypes.bool
 };
 export default PlaceholderGrid;

package/esm/Placeholder/PlaceholderParagraph.d.ts

@@ -1,10 +1,33 @@
 import { WithAsProps, RsRefForwardingComponent } from '../@types/common';
 export interface PlaceholderParagraphProps extends WithAsProps {
+    /**
+     * The number of rows.
+     * @default 2
+     */
     rows?: number;
+    /**
+     * The height of the row.
+     * @default 10
+     */
     rowHeight?: number;
+    /**
+     * @deprecated Use `rowSpacing` instead.
+     */
     rowMargin?: number;
+    /**
+     * The spacing between rows.
+     * @default 20
+     * @version 5.59.1
+     */
+    rowSpacing?: number;
+    /**
+     * The shape of the graph.
+     * @default false
+     */
     graph?: boolean | 'circle' | 'square' | 'image';
-    /** Placeholder status */
+    /**
+     * Placeholder status, display the loading state.
+     */
     active?: boolean;
 }
 /**

package/esm/Placeholder/PlaceholderParagraph.js

@@ -1,6 +1,8 @@
 'use client';
 import _extends from "@babel/runtime/helpers/esm/extends";
+import _taggedTemplateLiteralLoose from "@babel/runtime/helpers/esm/taggedTemplateLiteralLoose";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+var _templateObject;
 import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
@@ -19,11 +21,13 @@ var PlaceholderParagraph = /*#__PURE__*/React.forwardRef(function (props, ref) {
     rowHeight = _props$rowHeight === void 0 ? 10 : _props$rowHeight,
     _props$rowMargin = props.rowMargin,
     rowMargin = _props$rowMargin === void 0 ? 20 : _props$rowMargin,
+    _props$rowSpacing = props.rowSpacing,
+    rowSpacing = _props$rowSpacing === void 0 ? rowMargin : _props$rowSpacing,
     graph = props.graph,
     active = props.active,
     _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'placeholder' : _props$classPrefix,
-    rest = _objectWithoutPropertiesLoose(props, ["as", "className", "rows", "rowHeight", "rowMargin", "graph", "active", "classPrefix"]);
+    rest = _objectWithoutPropertiesLoose(props, ["as", "className", "rows", "rowHeight", "rowMargin", "rowSpacing", "graph", "active", "classPrefix"]);
   var _useClassNames = useClassNames(classPrefix),
     merge = _useClassNames.merge,
     prefix = _useClassNames.prefix,
@@ -33,17 +37,17 @@ var PlaceholderParagraph = /*#__PURE__*/React.forwardRef(function (props, ref) {
     var rowArr = [];
     for (var i = 0; i < rows; i++) {
       var styles = {
-        width: Math.random() * 75 + 25 + "%",
         height: rowHeight,
-        marginTop: i > 0 ? rowMargin : Number(rowMargin) / 2
+        marginTop: i > 0 ? rowSpacing : Number(rowSpacing) / 2
       };
-      rowArr.push( /*#__PURE__*/React.createElement("p", {
+      rowArr.push( /*#__PURE__*/React.createElement("div", {
         key: i,
-        style: styles
+        style: styles,
+        className: prefix(_templateObject || (_templateObject = _taggedTemplateLiteralLoose(["row"])))
       }));
     }
     return rowArr;
-  }, [rowHeight, rowMargin, rows]);
+  }, [prefix, rowHeight, rowSpacing, rows]);
   var classes = merge(className, withClassPrefix('paragraph', {
     active: active
   }));
@@ -56,7 +60,7 @@ var PlaceholderParagraph = /*#__PURE__*/React.forwardRef(function (props, ref) {
   }, /*#__PURE__*/React.createElement("span", {
     className: prefix('paragraph-graph-inner')
   })), /*#__PURE__*/React.createElement("div", {
-    className: prefix('paragraph-rows')
+    className: prefix('paragraph-group')
   }, rowElements));
 });
 PlaceholderParagraph.displayName = 'PlaceholderParagraph';
@@ -65,7 +69,7 @@ PlaceholderParagraph.propTypes = {
   classPrefix: PropTypes.string,
   rows: PropTypes.number,
   rowHeight: PropTypes.number,
-  rowMargin: PropTypes.number,
+  rowSpacing: PropTypes.number,
   graph: PropTypes.oneOfType([PropTypes.bool, oneOf(['circle', 'square', 'image'])]),
   active: PropTypes.bool
 };

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;