rsuite 5.47.0 → 5.48.0

package/cjs/Content/Content.js

@@ -6,6 +6,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
 /**
+ * The Content component is used to wrap content in a themed container with a max-width.
+ * @see https://rsuitejs.com/components/container/
+ *
  * For Internet Explorer 11 and lower, it's suggested that an ARIA role of "main"
  * be added to the <main> element to ensure it is accessible
  */

package/cjs/CustomProvider/CustomProvider.d.ts

@@ -158,6 +158,11 @@ declare const CustomContext: React.Context<CustomProviderProps<{
         off: string;
     } | undefined;
 }>>;
+/**
+ * CustomProvider is used to provide global configuration, such as language, theme, etc.
+ *
+ * @see https://rsuitejs.com/components/custom-provider
+ */
 declare const CustomProvider: (props: Omit<CustomProviderProps, 'toasters'>) => JSX.Element;
 export { CustomContext };
 export default CustomProvider;

package/cjs/CustomProvider/CustomProvider.js

@@ -15,6 +15,12 @@ var _utils = require("../utils");
 var CustomContext = /*#__PURE__*/_react.default.createContext({});
 exports.CustomContext = CustomContext;
 var themes = ['light', 'dark', 'high-contrast'];
+
+/**
+ * CustomProvider is used to provide global configuration, such as language, theme, etc.
+ *
+ * @see https://rsuitejs.com/components/custom-provider
+ */
 var CustomProvider = function CustomProvider(props) {
   var children = props.children,
     _props$classPrefix = props.classPrefix,

package/cjs/DOMHelper/index.d.ts

@@ -1,6 +1,10 @@
 /// <reference types="node" />
 import * as helpers from 'dom-lib';
 export * from 'dom-lib';
+/**
+ * a wrapper of dom-lib with some custom methods.
+ * @see https://rsuitejs.com/components/dom-helper/
+ */
 declare const DOMHelper: {
     isElement: (value: any) => value is HTMLElement;
     on: typeof helpers.on;

package/cjs/DOMHelper/index.js

@@ -15,6 +15,10 @@ Object.keys(helpers).forEach(function (key) {
   exports[key] = helpers[key];
 });
 var _isElement = _interopRequireDefault(require("./isElement"));
+/**
+ * a wrapper of dom-lib with some custom methods.
+ * @see https://rsuitejs.com/components/dom-helper/
+ */
 var DOMHelper = (0, _extends2.default)({}, helpers, {
   isElement: _isElement.default
 });

package/cjs/DateInput/DateField.d.ts

@@ -0,0 +1,180 @@
+/// <reference types="react" />
+import { type Locale } from 'date-fns';
+export declare const patternMap: {
+    y: string;
+    M: string;
+    d: string;
+    H: string;
+    h: string;
+    m: string;
+    s: string;
+    a: string;
+};
+export declare class DateField extends Object {
+    format: string;
+    patternArray: {
+        pattern: string;
+        key: string;
+    }[];
+    year: number | null;
+    month: number | null;
+    day: number | null;
+    hour: number | null;
+    minute: number | null;
+    second: number | null;
+    meridian: 'AM' | 'PM' | null;
+    constructor(format: string, value?: Date | null);
+}
+export declare const useDateField: (format: string, localize: Locale['localize'], date?: Date | null) => {
+    dateField: {
+        year: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: 'AM' | 'PM' | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        month: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: 'AM' | 'PM' | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        day: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: 'AM' | 'PM' | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        hour: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: 'AM' | 'PM' | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        minute: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        second: number | null;
+        meridian: 'AM' | 'PM' | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        second: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        meridian: 'AM' | 'PM' | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        meridian: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    };
+    dispatch: import("react").Dispatch<any>;
+    toDate: (type: string, value: number | null) => Date;
+    toDateString: () => string;
+};

package/cjs/DateInput/DateField.js

@@ -0,0 +1,151 @@
+'use client';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.useDateField = exports.DateField = exports.patternMap = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _inheritsLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/inheritsLoose"));
+var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
+var _react = require("react");
+var _utils = require("./utils");
+var patternMap = {
+  y: 'year',
+  M: 'month',
+  d: 'day',
+  H: 'hour',
+  h: 'hour',
+  m: 'minute',
+  s: 'second',
+  a: 'meridian'
+};
+exports.patternMap = patternMap;
+var DateField = /*#__PURE__*/function (_Object) {
+  (0, _inheritsLoose2.default)(DateField, _Object);
+  function DateField(format, value) {
+    var _this;
+    _this = _Object.call(this) || this;
+    _this.format = void 0;
+    _this.patternArray = [];
+    _this.year = null;
+    _this.month = null;
+    _this.day = null;
+    _this.hour = null;
+    _this.minute = null;
+    _this.second = null;
+    _this.meridian = null;
+    _this.format = format;
+    var formatArray = format.match(new RegExp('([y|d|M|H|h|m|s|a])+', 'ig')) || [];
+    _this.patternArray = formatArray.map(function (pattern) {
+      return {
+        pattern: pattern,
+        key: patternMap[pattern[0]]
+      };
+    });
+    if (value) {
+      _this.year = value.getFullYear();
+      _this.month = value.getMonth() + 1;
+      _this.day = value.getDate();
+      _this.hour = value.getHours();
+      _this.minute = value.getMinutes();
+      _this.second = value.getSeconds();
+      _this.meridian = value.getHours() > 12 ? 'PM' : 'AM';
+    }
+    return _this;
+  }
+  return DateField;
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Object));
+/**
+ * Pad a number with zeros to the left.
+ */
+exports.DateField = DateField;
+function padNumber(number, length) {
+  var numberString = String(number);
+  if (numberString.length >= length) {
+    return numberString;
+  }
+  var paddingCount = length - numberString.length;
+  for (var i = 0; i < paddingCount; i++) {
+    numberString = '0' + numberString;
+  }
+  return numberString;
+}
+var useDateField = function useDateField(format, localize, date) {
+  var _useReducer = (0, _react.useReducer)(function (state, action) {
+      switch (action.type) {
+        case 'setYear':
+          return (0, _extends2.default)({}, state, {
+            year: action.value
+          });
+        case 'setMonth':
+          return (0, _extends2.default)({}, state, {
+            month: action.value
+          });
+        case 'setDay':
+          return (0, _extends2.default)({}, state, {
+            day: action.value
+          });
+        case 'setHour':
+          return (0, _extends2.default)({}, state, {
+            hour: action.value
+          });
+        case 'setMinute':
+          return (0, _extends2.default)({}, state, {
+            minute: action.value
+          });
+        case 'setSecond':
+          return (0, _extends2.default)({}, state, {
+            second: action.value
+          });
+        case 'setMeridian':
+          return (0, _extends2.default)({}, state, {
+            meridian: action.value
+          });
+        default:
+          return state;
+      }
+    }, new DateField(format, date)),
+    dateField = _useReducer[0],
+    dispatch = _useReducer[1];
+  var toDateString = function toDateString() {
+    var str = format;
+    dateField.patternArray.forEach(function (item) {
+      var key = item.key,
+        pattern = item.pattern;
+      var value = dateField[key];
+      if (value !== null) {
+        if (pattern === 'MMM' && typeof value === 'number') {
+          value = localize === null || localize === void 0 ? void 0 : localize.month(value - 1, {
+            width: 'abbreviated'
+          });
+        } else if (pattern === 'MMMM' && typeof value === 'number') {
+          value = localize === null || localize === void 0 ? void 0 : localize.month(value - 1, {
+            width: 'wide'
+          });
+        } else if (pattern === 'aa' && typeof value === 'number') {
+          value = value === 0 ? 'AM' : 'PM';
+        } else if (pattern === 'hh' && typeof value === 'number') {
+          value = value === 0 ? 12 : value > 12 ? value - 12 : value;
+        }
+        if (typeof value === 'number') {
+          value = padNumber(value, pattern.length);
+        }
+        str = str.replace(pattern, value);
+      }
+    });
+    return str;
+  };
+  var toDate = function toDate(type, value) {
+    if (value === null) {
+      return new Date('');
+    }
+    return (0, _utils.modifyDate)(new Date(dateField.year, dateField.month ? dateField.month - 1 : 0, dateField.day, dateField.hour, dateField.minute, dateField.second), type, value);
+  };
+  return {
+    dateField: dateField,
+    dispatch: dispatch,
+    toDate: toDate,
+    toDateString: toDateString
+  };
+};
+exports.useDateField = useDateField;

package/cjs/DateInput/DateInput.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { InputProps } from '../Input';
+import { FormControlBaseProps } from '../@types/common';
+export interface DateInputProps extends Omit<InputProps, 'value' | 'onChange' | 'defaultValue'>, FormControlBaseProps<Date | null> {
+    /**
+     * Format of the date when rendered in the input.
+     * Format of the string is based on Unicode Technical Standard: https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
+     * @default 'yyyy-MM-dd'
+     **/
+    format?: string;
+}
+/**
+ * The DateInput component lets users select a date with the keyboard.
+ * @version 5.58.0
+ * @see https://rsuitejs.com/components/date-input/
+ */
+declare const DateInput: React.ForwardRefExoticComponent<DateInputProps & React.RefAttributes<unknown>>;
+export default DateInput;

package/cjs/DateInput/DateInput.js

@@ -0,0 +1,222 @@
+'use client';
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var _react = _interopRequireWildcard(require("react"));
+var _Input = _interopRequireDefault(require("../Input"));
+var _utils = require("../utils");
+var _utils2 = require("./utils");
+var _useDateInputState2 = _interopRequireDefault(require("./useDateInputState"));
+var isTestEnvironment = process.env.RUN_ENV === 'test';
+/**
+ * The DateInput component lets users select a date with the keyboard.
+ * @version 5.58.0
+ * @see https://rsuitejs.com/components/date-input/
+ */
+var DateInput = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
+  var _props$format = props.format,
+    formatStr = _props$format === void 0 ? 'yyyy-MM-dd' : _props$format,
+    valueProp = props.value,
+    defaultValue = props.defaultValue,
+    onChange = props.onChange,
+    onKeyDown = props.onKeyDown,
+    rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["format", "value", "defaultValue", "onChange", "onKeyDown"]);
+  var inputRef = (0, _react.useRef)();
+  var _useState = (0, _react.useState)({
+      selectedPattern: 'y',
+      selectionStart: 0,
+      selectionEnd: 0
+    }),
+    selectedState = _useState[0],
+    setSelectedState = _useState[1];
+  var _useCustom = (0, _utils.useCustom)('Calendar'),
+    locale = _useCustom.locale;
+  var localize = locale.dateLocale.localize;
+  var _useControlled = (0, _utils.useControlled)(valueProp, defaultValue),
+    value = _useControlled[0],
+    setValue = _useControlled[1],
+    isControlled = _useControlled[2];
+  var _useDateInputState = (0, _useDateInputState2.default)({
+      formatStr: formatStr,
+      localize: localize,
+      date: value,
+      isControlledDate: isControlled
+    }),
+    dateField = _useDateInputState.dateField,
+    setDateOffset = _useDateInputState.setDateOffset,
+    setDateField = _useDateInputState.setDateField,
+    getDateField = _useDateInputState.getDateField,
+    toDateString = _useDateInputState.toDateString;
+  var dateString = toDateString();
+  var keyPressOptions = (0, _react.useMemo)(function () {
+    return {
+      formatStr: formatStr,
+      localize: localize,
+      selectedMonth: dateField.month,
+      dateString: dateString
+    };
+  }, [dateField, dateString, formatStr, localize]);
+  var setSelectionRange = (0, _react.useCallback)(function (selectionStart, selectionEnd) {
+    if (selectionStart === void 0) {
+      selectionStart = selectedState.selectionStart;
+    }
+    if (selectionEnd === void 0) {
+      selectionEnd = selectedState.selectionEnd;
+    }
+    var input = inputRef === null || inputRef === void 0 ? void 0 : inputRef.current;
+    if (isTestEnvironment) {
+      (0, _utils.safeSetSelection)(input, selectionStart, selectionEnd);
+      return;
+    }
+    requestAnimationFrame(function () {
+      (0, _utils.safeSetSelection)(input, selectionStart, selectionEnd);
+    });
+  }, [selectedState]);
+  var handleChange = (0, _react.useCallback)(function (value, event) {
+    setValue(value);
+    onChange === null || onChange === void 0 ? void 0 : onChange(value, event);
+  }, [onChange, setValue]);
+  var handleChangeField = (0, _react.useCallback)(function (event, nextDirection) {
+    var input = event.target;
+    var direction = nextDirection || (event.key === 'ArrowRight' ? 'right' : 'left');
+    var state = (0, _utils2.getInputSelectedState)((0, _extends2.default)({}, keyPressOptions, {
+      input: input,
+      direction: direction
+    }));
+    setSelectionRange(state.selectionStart, state.selectionEnd);
+    setSelectedState(state);
+  }, [keyPressOptions, setSelectionRange]);
+  var handleChangeFieldValue = (0, _react.useCallback)(function (event) {
+    var key = event.key;
+    var input = event.target;
+    var offset = key === 'ArrowUp' ? 1 : -1;
+    var state = (0, _utils2.getInputSelectedState)((0, _extends2.default)({}, keyPressOptions, {
+      input: input,
+      valueOffset: offset
+    }));
+    setSelectedState(state);
+    setDateOffset(state.selectedPattern, offset, function (date) {
+      return handleChange(date, event);
+    });
+    setSelectionRange(state.selectionStart, state.selectionEnd);
+  }, [handleChange, keyPressOptions, setDateOffset, setSelectionRange]);
+  var isFieldFullValue = (0, _react.useCallback)(function (value, pattern) {
+    var patternGroup = (0, _utils2.getPatternGroups)(formatStr, pattern);
+    if (value.toString().length === patternGroup.length) {
+      return true;
+    }
+    switch (pattern) {
+      case 'M':
+        return parseInt(value + "0") > 12;
+      case 'd':
+        return parseInt(value + "0") > 31;
+      case 'H':
+        return parseInt(value + "0") > 23;
+      case 'h':
+        return parseInt(value + "0") > 12;
+      case 'm':
+      case 's':
+        return parseInt(value + "0") > 59;
+      default:
+        return false;
+    }
+  }, [formatStr]);
+  var handleChangeFieldValueWithNumericKeys = (0, _react.useCallback)(function (event) {
+    var key = event.key;
+    var input = event.target;
+    var pattern = selectedState.selectedPattern;
+    if (!pattern) {
+      return;
+    }
+    var field = getDateField(pattern);
+    var value = parseInt(key, 10);
+    var padValue = parseInt("" + (field.value || '') + key, 10);
+    var newValue = value;
+
+    // Check if the value entered by the user is a valid date
+    if ((0, _utils2.validateDateTime)(field.name, padValue)) {
+      newValue = padValue;
+    }
+    if (pattern === 'M') {
+      // Month cannot be less than 1.
+      newValue = Math.max(1, newValue);
+    }
+    setDateField(pattern, newValue, function (date) {
+      return handleChange(date, event);
+    });
+
+    // The currently selected month will be retained as a parameter of getInputSelectedState,
+    // but if the user enters a month, the month value will be replaced with the value entered by the user.
+    var selectedMonth = pattern === 'M' ? newValue : dateField.month;
+    var nextState = (0, _utils2.getInputSelectedState)((0, _extends2.default)({}, keyPressOptions, {
+      input: input,
+      selectedMonth: selectedMonth
+    }));
+    setSelectedState(nextState);
+    setSelectionRange(nextState.selectionStart, nextState.selectionEnd);
+
+    // If the field is full value, move the cursor to the next field
+    if (isFieldFullValue(newValue, pattern) && input.selectionEnd !== input.value.length) {
+      handleChangeField(event, 'right');
+    }
+  }, [dateField, getDateField, handleChange, handleChangeField, isFieldFullValue, keyPressOptions, selectedState.selectedPattern, setDateField, setSelectionRange]);
+  var handleRemoveFieldValue = (0, _react.useCallback)(function (event) {
+    if (selectedState.selectedPattern) {
+      setDateField(selectedState.selectedPattern, null, function (date) {
+        return handleChange(date, event);
+      });
+      setSelectionRange();
+    }
+  }, [handleChange, selectedState, setDateField, setSelectionRange]);
+  var handleKeyDown = function handleKeyDown(event) {
+    var _key$match;
+    var key = event.key;
+    switch (key) {
+      case 'ArrowRight':
+      case 'ArrowLeft':
+        handleChangeField(event);
+        event.preventDefault();
+        break;
+      case 'ArrowUp':
+      case 'ArrowDown':
+        handleChangeFieldValue(event);
+        event.preventDefault();
+        break;
+      case 'Backspace':
+        handleRemoveFieldValue(event);
+        event.preventDefault();
+        break;
+      case (_key$match = key.match(/\d/)) === null || _key$match === void 0 ? void 0 : _key$match.input:
+        handleChangeFieldValueWithNumericKeys(event);
+        event.preventDefault();
+        break;
+    }
+    onKeyDown === null || onKeyDown === void 0 ? void 0 : onKeyDown(event);
+  };
+  var handleClick = (0, _react.useCallback)(function (event) {
+    var input = event.target;
+    var state = (0, _utils2.getInputSelectedState)((0, _extends2.default)({}, keyPressOptions, {
+      input: input
+    }));
+    setSelectedState(state);
+    setSelectionRange(state.selectionStart, state.selectionEnd);
+  }, [keyPressOptions, setSelectionRange]);
+  return /*#__PURE__*/_react.default.createElement(_Input.default, (0, _extends2.default)({
+    inputMode: "text",
+    autoComplete: "off",
+    autoCorrect: "off",
+    spellCheck: false,
+    ref: (0, _utils.mergeRefs)(inputRef, ref),
+    onKeyDown: handleKeyDown,
+    onClick: handleClick,
+    value: dateString
+  }, rest));
+});
+DateInput.displayName = 'DateInput';
+var _default = DateInput;
+exports.default = _default;

package/cjs/DateInput/index.d.ts

@@ -0,0 +1,3 @@
+import DateInput from './DateInput';
+export type { DateInputProps } from './DateInput';
+export default DateInput;

package/cjs/DateInput/index.js

@@ -0,0 +1,9 @@
+'use client';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _DateInput = _interopRequireDefault(require("./DateInput"));
+var _default = _DateInput.default;
+exports.default = _default;