rsuite 5.46.1 → 5.48.0

package/cjs/DateInput/utils.js

@@ -0,0 +1,159 @@
+'use client';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.getPatternGroups = getPatternGroups;
+exports.getInputSelectedState = getInputSelectedState;
+exports.validateDateTime = validateDateTime;
+exports.modifyDate = modifyDate;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _dateUtils = require("../utils/dateUtils");
+function getPatternGroups(format, pattern) {
+  var _format$match;
+  return ((_format$match = format.match(new RegExp("(" + pattern + ")+"))) === null || _format$match === void 0 ? void 0 : _format$match[0]) || '';
+}
+function getInputSelectedState(options) {
+  var input = options.input,
+    direction = options.direction,
+    formatStr = options.formatStr,
+    localize = options.localize,
+    selectedMonth = options.selectedMonth,
+    dateString = options.dateString,
+    _options$valueOffset = options.valueOffset,
+    valueOffset = _options$valueOffset === void 0 ? 0 : _options$valueOffset;
+  var getSelectIndexGap = function getSelectIndexGap(pattern) {
+    var gap = 0;
+    var monthIsAbbreviated = formatStr.includes('MMM');
+    var monthIsFull = formatStr.includes('MMMM');
+
+    // If the month is abbreviated or full, the gap needs to be adjusted.
+    if (monthIsAbbreviated || monthIsFull) {
+      var isSelected = pattern === 'M';
+      if (selectedMonth === null && valueOffset === 0) {
+        return gap;
+      }
+      var month = selectedMonth ? selectedMonth + (isSelected ? valueOffset : 0) : 1;
+      if (month > 12) {
+        month = 1;
+      } else if (month === 0) {
+        month = 12;
+      }
+      var monthStr = localize === null || localize === void 0 ? void 0 : localize.month(month - 1, {
+        width: monthIsFull ? 'wide' : 'abbreviated'
+      });
+      gap = monthStr.length - (monthIsFull ? 4 : 3);
+    }
+    return gap;
+  };
+  var getDatePattern = function getDatePattern(selectionIndex, positionOffset) {
+    if (positionOffset === void 0) {
+      positionOffset = -1;
+    }
+    var pattern = formatStr.charAt((input === null || input === void 0 ? void 0 : input.selectionStart) || 0);
+    if (selectionIndex < 0 || selectionIndex > dateString.length - 1) {
+      pattern = formatStr.trim().charAt(0);
+      return pattern;
+    }
+    var gap = getSelectIndexGap(pattern);
+    pattern = formatStr.charAt(selectionIndex - gap);
+
+    // If the pattern is not a letter, then get the pattern from the previous or next letter.
+    if (!pattern.match(/[y|d|M|H|h|m|s|a]/)) {
+      var nextIndex = selectionIndex + positionOffset;
+      pattern = getDatePattern(nextIndex, positionOffset);
+    }
+    return pattern;
+  };
+  var getPatternSelectedIndexes = function getPatternSelectedIndexes(pattern) {
+    var selectionStart = formatStr.indexOf(pattern);
+    var selectionEnd = formatStr.lastIndexOf(pattern) + 1;
+    var gap = getSelectIndexGap(pattern);
+    if (pattern === 'M') {
+      return {
+        selectionStart: selectionStart,
+        selectionEnd: selectionEnd + gap
+      };
+    }
+    return {
+      selectionStart: selectionStart + gap,
+      selectionEnd: selectionEnd + gap
+    };
+  };
+  if (typeof input.selectionEnd === 'number' && typeof input.selectionStart === 'number') {
+    var index = input.selectionStart;
+    var positionOffset = -1;
+    if (direction === 'left') {
+      index = input.selectionStart - 1;
+    } else if (direction === 'right') {
+      index = input.selectionEnd + 1;
+      positionOffset = 1;
+    }
+    var datePattern = getDatePattern(index, positionOffset);
+    var indexes = getPatternSelectedIndexes(datePattern);
+    return (0, _extends2.default)({
+      selectedPattern: datePattern
+    }, indexes);
+  }
+  return {
+    selectedPattern: 'y',
+    selectionStart: 0,
+    selectionEnd: 0
+  };
+}
+function validateDateTime(type, value) {
+  switch (type) {
+    case 'year':
+      if (value < 1 || value > 9999) {
+        return false;
+      }
+      break;
+    case 'month':
+      if (value < 1 || value > 12) {
+        return false;
+      }
+      break;
+    case 'day':
+      if (value < 1 || value > 31) {
+        return false;
+      }
+      break;
+    case 'hour':
+      if (value < 0 || value > 23) {
+        return false;
+      }
+      break;
+    case 'minute':
+      if (value < 0 || value > 59) {
+        return false;
+      }
+      break;
+    case 'second':
+      if (value < 0 || value > 59) {
+        return false;
+      }
+      break;
+    default:
+      return false;
+    // Invalid type
+  }
+
+  return true;
+}
+function modifyDate(date, type, value) {
+  switch (type) {
+    case 'year':
+      return (0, _dateUtils.setYear)(date, value);
+    case 'month':
+      return (0, _dateUtils.setMonth)(date, value - 1);
+    case 'day':
+      return (0, _dateUtils.setDate)(date, value);
+    case 'hour':
+      return (0, _dateUtils.setHours)(date, value);
+    case 'minute':
+      return (0, _dateUtils.setMinutes)(date, value);
+    case 'second':
+      return (0, _dateUtils.setSeconds)(date, value);
+  }
+  return date;
+}

package/cjs/DatePicker/DatePicker.d.ts

@@ -101,5 +101,10 @@ export interface DatePickerProps extends PickerBaseProps<DatePickerLocale>, Form
     /** Custom render value */
     renderValue?: (value: Date, format: string) => string;
 }
+/**
+ * A date picker allows users to select a date from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-picker
+ */
 declare const DatePicker: RsRefForwardingComponent<'div', DatePickerProps>;
 export default DatePicker;

package/cjs/DatePicker/DatePicker.js

@@ -28,6 +28,11 @@ var _Picker = require("../Picker");
 var _OverlayTrigger = require("../Overlay/OverlayTrigger");
 var _deprecatePropType = require("../utils/deprecatePropType");
 var _utils2 = require("../Calendar/utils");
+/**
+ * A date picker allows users to select a date from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-picker
+ */
 var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/DateRangePicker/DateRangePicker.d.ts

@@ -70,5 +70,10 @@ export interface DateRangePicker extends PickerComponent<DateRangePickerProps> {
     /** Used to combine multiple conditions */
     combine?: (...args: any) => DisabledDateFunction;
 }
+/**
+ * A date range picker allows you to select a date range from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-range-picker
+ */
 declare const DateRangePicker: DateRangePicker;
 export default DateRangePicker;

package/cjs/DateRangePicker/DateRangePicker.js

@@ -27,6 +27,11 @@ var disabledDateUtils = _interopRequireWildcard(require("./disabledDateUtils"));
 var _utils2 = require("./utils");
 var _deprecatePropType = require("../utils/deprecatePropType");
 var _DateRangePickerContext = _interopRequireDefault(require("./DateRangePickerContext"));
+/**
+ * A date range picker allows you to select a date range from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-range-picker
+ */
 var DateRangePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _ref, _ref2, _merge;
   var _props$as = props.as,

package/cjs/Divider/Divider.d.ts

@@ -5,5 +5,9 @@ export interface DividerProps extends WithAsProps {
      */
     vertical?: boolean;
 }
+/**
+ * The Divider component is used to separate content.
+ * @see https://rsuitejs.com/components/divider
+ */
 declare const Divider: RsRefForwardingComponent<'div', DividerProps>;
 export default Divider;

package/cjs/Divider/Divider.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The Divider component is used to separate content.
+ * @see https://rsuitejs.com/components/divider
+ */
 var Divider = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Drawer/Drawer.d.ts

@@ -22,5 +22,9 @@ interface DrawerComponent extends React.FC<DrawerProps> {
      */
     Footer: typeof DrawerFooter;
 }
+/**
+ * The Drawer component is used to display extra content from a main content.
+ * @see https://rsuitejs.com/components/drawer
+ */
 declare const Drawer: DrawerComponent;
 export default Drawer;

package/cjs/Drawer/Drawer.js

@@ -49,6 +49,10 @@ var DrawerTitle = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     ref: ref
   }));
 });
+/**
+ * The Drawer component is used to display extra content from a main content.
+ * @see https://rsuitejs.com/components/drawer
+ */
 var Drawer = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$placement = props.placement,

package/cjs/Dropdown/Dropdown.d.ts

@@ -62,9 +62,12 @@ export interface DropdownComponent extends RsRefForwardingComponent<'div', Dropd
     Separator: typeof DropdownSeparator;
 }
 /**
- * The <Dropdown> API
- * When used inside <Sidenav>, renders a <TreeviewRootItem>;
- * Otherwise renders a <MenuRoot>
+ * The `Dropdown` component is used to select an option from a set of options.
+ * @see https://rsuitejs.com/components/dropdown
+ *
+ * The `<Dropdown>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewRootItem>`;
+ * - Otherwise renders a `<MenuRoot>`
  */
 declare const Dropdown: DropdownComponent;
 export default Dropdown;

package/cjs/Dropdown/Dropdown.js

@@ -25,9 +25,12 @@ var _warnOnce = _interopRequireDefault(require("../utils/warnOnce"));
 var _Nav = _interopRequireDefault(require("../Nav"));
 var _DropdownSeparator = _interopRequireDefault(require("./DropdownSeparator"));
 /**
- * The <Dropdown> API
- * When used inside <Sidenav>, renders a <TreeviewRootItem>;
- * Otherwise renders a <MenuRoot>
+ * The `Dropdown` component is used to select an option from a set of options.
+ * @see https://rsuitejs.com/components/dropdown
+ *
+ * The `<Dropdown>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewRootItem>`;
+ * - Otherwise renders a `<MenuRoot>`
  */
 var Dropdown = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var activeKey = props.activeKey,

package/cjs/Dropdown/DropdownItem.d.ts

@@ -39,9 +39,9 @@ export interface DropdownMenuItemProps<T = any> extends WithAsProps, Omit<React.
     onSelect?: (eventKey: T, event: React.SyntheticEvent) => void;
 }
 /**
- * The <Dropdown.Item> API
- * When used inside <Sidenav>, renders a <TreeviewItem>
- * Otherwise renders a <MenuItem>
+ * The `<Dropdown.Item>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewItem>`
+ * - Otherwise renders a `<MenuItem>`
  */
 declare const DropdownItem: RsRefForwardingComponent<'li', DropdownMenuItemProps>;
 export default DropdownItem;

package/cjs/Dropdown/DropdownItem.js

@@ -23,9 +23,9 @@ var _warnOnce = _interopRequireDefault(require("../utils/warnOnce"));
 var _Nav = _interopRequireDefault(require("../Nav"));
 var _DropdownSeparator = _interopRequireDefault(require("./DropdownSeparator"));
 /**
- * The <Dropdown.Item> API
- * When used inside <Sidenav>, renders a <TreeviewItem>
- * Otherwise renders a <MenuItem>
+ * The `<Dropdown.Item>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewItem>`
+ * - Otherwise renders a `<MenuItem>`
  */
 var DropdownItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,

package/cjs/Dropdown/DropdownMenu.d.ts

@@ -23,11 +23,11 @@ export interface DropdownMenuProps<T = string> extends StandardProps {
     onToggle?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
 }
 /**
- * The <Dropdown.Menu> API
+ * The `<Dropdown.Menu>` API
  *
  * @description
- * Note the difference between this component and <Menu> component:
- * <Menu> is used for ARIA menu control logic and is used internally only.
+ * Note the difference between this component and `<Menu>` component:
+ * `<Menu>` is used for ARIA menu control logic and is used internally only.
  * This component is only used for supporting submenu syntax and is
  * assigned to Dropdown.Menu
  *

package/cjs/Dropdown/DropdownMenu.js

@@ -24,11 +24,11 @@ var _NavContext = _interopRequireDefault(require("../Nav/NavContext"));
 var _warnOnce = _interopRequireDefault(require("../utils/warnOnce"));
 var _templateObject, _templateObject2;
 /**
- * The <Dropdown.Menu> API
+ * The `<Dropdown.Menu>` API
  *
  * @description
- * Note the difference between this component and <Menu> component:
- * <Menu> is used for ARIA menu control logic and is used internally only.
+ * Note the difference between this component and `<Menu>` component:
+ * `<Menu>` is used for ARIA menu control logic and is used internally only.
  * This component is only used for supporting submenu syntax and is
  * assigned to Dropdown.Menu
  *

package/cjs/Dropdown/DropdownSeparator.d.ts

@@ -5,7 +5,7 @@ export interface DropdownSeparatorProps extends WithAsProps, React.HTMLAttribute
     as?: React.ElementType;
 }
 /**
- * The <Dropdown.Separator> API
+ * The `<Dropdown.Separator>` API
  *
  * Renders a non-focusable and non-interactive `separator`
  * Per ARIA APG https://www.w3.org/WAI/ARIA/apg/patterns/menu/

package/cjs/Dropdown/DropdownSeparator.js

@@ -10,7 +10,7 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 /**
- * The <Dropdown.Separator> API
+ * The `<Dropdown.Separator>` API
  *
  * Renders a non-focusable and non-interactive `separator`
  * Per ARIA APG https://www.w3.org/WAI/ARIA/apg/patterns/menu/

package/cjs/FlexboxGrid/FlexboxGrid.d.ts

@@ -9,5 +9,9 @@ export interface FlexboxGridProps extends WithAsProps {
 interface FlexboxGridCompont extends RsRefForwardingComponent<'div', FlexboxGridProps> {
     Item: typeof FlexboxGridItem;
 }
+/**
+ * The FlexboxGrid component is a box that can be used to layout other components.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 declare const FlexboxGrid: FlexboxGridCompont;
 export default FlexboxGrid;

package/cjs/FlexboxGrid/FlexboxGrid.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _FlexboxGridItem = _interopRequireDefault(require("./FlexboxGridItem"));
+/**
+ * The FlexboxGrid component is a box that can be used to layout other components.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 var FlexboxGrid = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/FlexboxGrid/FlexboxGridItem.d.ts

@@ -5,5 +5,9 @@ export interface FlexboxGridItemProps extends WithAsProps {
     /** grid orders for sorting */
     order?: number;
 }
+/**
+ * The `FlexboxGrid.Item` component is used to specify the layout of the child element in the `FlexboxGrid` component.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 declare const FlexboxGridItem: RsRefForwardingComponent<'div', FlexboxGridItemProps>;
 export default FlexboxGridItem;

package/cjs/FlexboxGrid/FlexboxGridItem.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `FlexboxGrid.Item` component is used to specify the layout of the child element in the `FlexboxGrid` component.
+ * @see https://rsuitejs.com/components/flexbox-grid
+ */
 var FlexboxGridItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/cjs/Footer/Footer.d.ts

@@ -1,4 +1,8 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type FooterProps = ComponentProps;
+/**
+ * The `<Footer>` component is used to specify the footer of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 declare const Footer: import("../@types/common").RsRefForwardingComponent<"footer", ComponentProps>;
 export default Footer;

package/cjs/Footer/Footer.js

@@ -5,6 +5,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `<Footer>` component is used to specify the footer of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Footer = (0, _createComponent.default)({
   name: 'Footer',
   componentAs: 'footer'

package/cjs/Form/Form.d.ts

@@ -69,5 +69,9 @@ export interface FormComponent extends RsRefForwardingComponent<'form', FormProp
     Group: typeof FormGroup;
     HelpText: typeof FormHelpText;
 }
+/**
+ * The `Form` component is a form interface for collecting and validating user input.
+ * @see https://rsuitejs.com/components/form
+ */
 declare const Form: FormComponent;
 export default Form;

package/cjs/Form/Form.js

@@ -20,6 +20,10 @@ var _FormHelpText = _interopRequireDefault(require("../FormHelpText"));
 var _useFormClassNames = require("./useFormClassNames");
 var _useSchemaModel2 = _interopRequireDefault(require("./useSchemaModel"));
 var _utils = require("../utils");
+/**
+ * The `Form` component is a form interface for collecting and validating user input.
+ * @see https://rsuitejs.com/components/form
+ */
 var Form = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$checkTrigger = props.checkTrigger,
     checkTrigger = _props$checkTrigger === void 0 ? 'change' : _props$checkTrigger,

package/cjs/FormControl/FormControl.d.ts

@@ -39,5 +39,9 @@ interface FormControlComponent extends React.FC<FormControlProps> {
         accepter?: Accepter;
     } & React.ComponentPropsWithRef<Accepter>): React.ReactElement | null;
 }
+/**
+ * The `<Form.Control>` component is used to wrap the components that need to be validated.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormControl: FormControlComponent;
 export default FormControl;

package/cjs/FormControl/FormControl.js

@@ -23,6 +23,10 @@ var _templateObject;
  * Props that FormControl passes to its accepter
  */
 
+/**
+ * The `<Form.Control>` component is used to wrap the components that need to be validated.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormControl = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _accepterProps;
   var _useContext = (0, _react.useContext)(_FormContext.default),

package/cjs/FormControlLabel/FormControlLabel.d.ts

@@ -4,5 +4,9 @@ export interface FormControlLabelProps extends WithAsProps, React.LabelHTMLAttri
     /** Attribute of the html label tag, defaults to the controlId of the FormGroup */
     htmlFor?: string;
 }
+/**
+ * The `<Form.ControlLabel>` component renders a label with required indicator, for form controls.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormControlLabel: RsRefForwardingComponent<'label', FormControlLabelProps>;
 export default FormControlLabel;

package/cjs/FormControlLabel/FormControlLabel.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _FormGroup = require("../FormGroup/FormGroup");
+/**
+ * The `<Form.ControlLabel>` component renders a label with required indicator, for form controls.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormControlLabel = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'label' : _props$as,

package/cjs/FormErrorMessage/FormErrorMessage.d.ts

@@ -5,5 +5,9 @@ export interface FormErrorMessageProps extends WithAsProps {
     /** The placement of error messages */
     placement?: TypeAttributes.Placement8;
 }
+/**
+ * The `<Form.ErrorMessage>` component is used to display error messages in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormErrorMessage: RsRefForwardingComponent<'div', FormErrorMessageProps>;
 export default FormErrorMessage;

package/cjs/FormErrorMessage/FormErrorMessage.js

@@ -12,6 +12,10 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _kebabCase = _interopRequireDefault(require("lodash/kebabCase"));
 var _utils = require("../utils");
 var _templateObject, _templateObject2;
+/**
+ * The `<Form.ErrorMessage>` component is used to display error messages in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormErrorMessage = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _prefix;
   var _props$as = props.as,

package/cjs/FormGroup/FormGroup.d.ts

@@ -10,5 +10,9 @@ export interface FormGroupProps extends WithAsProps {
 export declare const FormGroupContext: React.Context<{
     controlId?: string | undefined;
 }>;
+/**
+ * The `<Form.Group>` component is the easiest way to add some structure to forms.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormGroup: RsRefForwardingComponent<'div', FormGroupProps>;
 export default FormGroup;

package/cjs/FormGroup/FormGroup.js

@@ -11,6 +11,11 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var FormGroupContext = /*#__PURE__*/_react.default.createContext({});
+
+/**
+ * The `<Form.Group>` component is the easiest way to add some structure to forms.
+ * @see https://rsuitejs.com/components/form/
+ */
 exports.FormGroupContext = FormGroupContext;
 var FormGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,

package/cjs/FormHelpText/FormHelpText.d.ts

@@ -3,5 +3,9 @@ export interface FormHelpTextProps extends WithAsProps {
     /** Whether to show through the Tooltip component */
     tooltip?: boolean;
 }
+/**
+ * The `<Form.HelpText>` component is used to display help information in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 declare const FormHelpText: RsRefForwardingComponent<'span', FormHelpTextProps>;
 export default FormHelpText;

package/cjs/FormHelpText/FormHelpText.js

@@ -14,6 +14,10 @@ var _Whisper = _interopRequireDefault(require("../Whisper"));
 var _utils = require("../utils");
 var _FormGroup = require("../FormGroup/FormGroup");
 var _HelpO = _interopRequireDefault(require("@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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,

package/cjs/Grid/Grid.d.ts

@@ -3,5 +3,9 @@ export interface GridProps extends WithAsProps {
     /** Fluid layout */
     fluid?: boolean;
 }
+/**
+ * The Grid component is used to specify the layout of child elements in rows and columns.
+ * @see https://rsuitejs.com/components/grid
+ */
 declare const Grid: RsRefForwardingComponent<'div', GridProps>;
 export default Grid;

package/cjs/Grid/Grid.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The Grid component is used to specify the layout of child elements in rows and columns.
+ * @see https://rsuitejs.com/components/grid
+ */
 var Grid = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Header/Header.d.ts

@@ -1,4 +1,8 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type HeaderProps = ComponentProps;
+/**
+ * The `<Header>` component is used to specify the header of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 declare const Header: import("../@types/common").RsRefForwardingComponent<"header", ComponentProps>;
 export default Header;

package/cjs/Header/Header.js

@@ -5,6 +5,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `<Header>` component is used to specify the header of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Header = (0, _createComponent.default)({
   name: 'Header',
   componentAs: 'header'

package/cjs/IconButton/IconButton.d.ts

@@ -10,6 +10,10 @@ export interface IconButtonProps extends ButtonProps {
     /** The placement of icon */
     placement?: 'left' | 'right';
 }
+/**
+ * The `IconButton` component is used to specify a button with icon.
+ * @see https://rsuitejs.com/components/button
+ */
 declare const IconButton: RsRefForwardingComponent<typeof Button, IconButtonProps & {
     ref?: React.Ref<HTMLElement>;
 }>;