rsuite 5.47.0 → 5.48.0

package/esm/FlexboxGrid/FlexboxGrid.js

@@ -5,6 +5,10 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import FlexboxGridItem from './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.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/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/esm/FlexboxGrid/FlexboxGridItem.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../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.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/esm/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/esm/Footer/Footer.js

@@ -1,5 +1,9 @@
 'use client';
 import createComponent from '../utils/createComponent';
+/**
+ * The `<Footer>` component is used to specify the footer of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Footer = createComponent({
   name: 'Footer',
   componentAs: 'footer'

package/esm/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/esm/Form/Form.js

@@ -14,6 +14,10 @@ import FormHelpText from '../FormHelpText';
 import { useFormClassNames } from './useFormClassNames';
 import useSchemaModel from './useSchemaModel';
 import { useControlled } from '../utils';
+/**
+ * The `Form` component is a form interface for collecting and validating user input.
+ * @see https://rsuitejs.com/components/form
+ */
 var Form = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$checkTrigger = props.checkTrigger,
     checkTrigger = _props$checkTrigger === void 0 ? 'change' : _props$checkTrigger,

package/esm/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/esm/FormControl/FormControl.js

@@ -19,6 +19,10 @@ import Toggle from '../Toggle';
  * 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.forwardRef(function (props, ref) {
   var _accepterProps;
   var _useContext = useContext(FormContext),

package/esm/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/esm/FormControlLabel/FormControlLabel.js

@@ -5,6 +5,10 @@ import React, { useContext } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import { FormGroupContext } from '../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.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'label' : _props$as,

package/esm/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/esm/FormErrorMessage/FormErrorMessage.js

@@ -7,6 +7,10 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import kebabCase from 'lodash/kebabCase';
 import { placementPolyfill, useClassNames } from '../utils';
+/**
+ * The `<Form.ErrorMessage>` component is used to display error messages in the form.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormErrorMessage = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _prefix;
   var _props$as = props.as,

package/esm/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/esm/FormGroup/FormGroup.js

@@ -5,6 +5,11 @@ import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 export var FormGroupContext = /*#__PURE__*/React.createContext({});
+
+/**
+ * The `<Form.Group>` component is the easiest way to add some structure to forms.
+ * @see https://rsuitejs.com/components/form/
+ */
 var FormGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/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/esm/FormHelpText/FormHelpText.js

@@ -8,6 +8,10 @@ import Whisper from '../Whisper';
 import { useClassNames } from '../utils';
 import { FormGroupContext } from '../FormGroup/FormGroup';
 import HelpO 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 _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,

package/esm/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/esm/Grid/Grid.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../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.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/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/esm/Header/Header.js

@@ -1,5 +1,9 @@
 'use client';
 import createComponent from '../utils/createComponent';
+/**
+ * The `<Header>` component is used to specify the header of the page.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Header = createComponent({
   name: 'Header',
   componentAs: 'header'

package/esm/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>;
 }>;

package/esm/IconButton/IconButton.js

@@ -5,6 +5,10 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import Button from '../Button';
+/**
+ * The `IconButton` component is used to specify a button with icon.
+ * @see https://rsuitejs.com/components/button
+ */
 var IconButton = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var icon = props.icon,
     _props$placement = props.placement,

package/esm/Input/Input.d.ts

@@ -17,5 +17,9 @@ export interface InputProps extends WithAsProps, Omit<React.InputHTMLAttributes<
     /** Called on press enter */
     onPressEnter?: React.KeyboardEventHandler<HTMLInputElement>;
 }
+/**
+ * The `<Input>` component is used to get user input in a text field.
+ * @see https://rsuitejs.com/components/input
+ */
 declare const Input: RsRefForwardingComponent<'input', InputProps>;
 export default Input;

package/esm/Input/Input.js

@@ -7,6 +7,10 @@ import { FormGroupContext } from '../FormGroup/FormGroup';
 import { InputGroupContext } from '../InputGroup/InputGroup';
 import Plaintext from '../Plaintext';
 import { createChainedFunction, TypeChecker, mergeRefs, useClassNames, KEY_VALUES } from '../utils';
+/**
+ * The `<Input>` component is used to get user input in a text field.
+ * @see https://rsuitejs.com/components/input
+ */
 var Input = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var className = props.className,
     _props$classPrefix = props.classPrefix,

package/esm/InputGroup/InputGroup.d.ts

@@ -20,5 +20,9 @@ export interface InputGroupComponent extends RsRefForwardingComponent<'div', Inp
     Addon: typeof InputGroupAddon;
     Button: typeof InputGroupButton;
 }
+/**
+ * The `InputGroup` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroup: InputGroupComponent;
 export default InputGroup;

package/esm/InputGroup/InputGroup.js

@@ -7,6 +7,10 @@ import InputGroupAddon from './InputGroupAddon';
 import InputGroupButton from './InputGroupButton';
 import { useClassNames } from '../utils';
 export var InputGroupContext = /*#__PURE__*/React.createContext(null);
+/**
+ * The `InputGroup` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/InputGroup/InputGroupAddon.d.ts

@@ -4,5 +4,9 @@ export interface InputGroupAddonProps extends WithAsProps, React.HTMLAttributes<
     /** An Input group addon can show that it is disabled */
     disabled?: boolean;
 }
+/**
+ * The `InputGroup.Addon` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroupAddon: RsRefForwardingComponent<'span', InputGroupAddonProps>;
 export default InputGroupAddon;

package/esm/InputGroup/InputGroupAddon.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
+/**
+ * The `InputGroup.Addon` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroupAddon = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,

package/esm/InputGroup/InputGroupButton.d.ts

@@ -1,4 +1,8 @@
 import React from 'react';
 import { ButtonProps } from '../Button';
+/**
+ * The `InputGroup.Button` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroupButton: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<any>>;
 export default InputGroupButton;

package/esm/InputGroup/InputGroupButton.js

@@ -4,6 +4,11 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import { useClassNames } from '../utils';
 import Button from '../Button';
+
+/**
+ * The `InputGroup.Button` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroupButton = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'input-group-btn' : _props$classPrefix,

package/esm/InputNumber/InputNumber.d.ts

@@ -21,5 +21,9 @@ export interface InputNumberProps<T = number | string> extends Omit<React.InputH
     scrollable?: boolean;
     onWheel?: (event: React.WheelEvent) => void;
 }
+/**
+ * The `InputNumber` component is used to enter a numerical value.
+ * @see https://rsuitejs.com/components/input-number
+ */
 declare const InputNumber: React.ForwardRefExoticComponent<InputNumberProps<string | number> & React.RefAttributes<unknown>>;
 export default InputNumber;

package/esm/InputNumber/InputNumber.js

@@ -66,6 +66,11 @@ function valueReachesMin(value, min) {
   }
   return false;
 }
+
+/**
+ * The `InputNumber` component is used to enter a numerical value.
+ * @see https://rsuitejs.com/components/input-number
+ */
 var InputNumber = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? InputGroup : _props$as,

package/esm/InputPicker/InputPicker.d.ts

@@ -29,5 +29,10 @@ export interface InputPickerProps<T = ValueType> extends FormControlPickerProps<
      */
     shouldDisplayCreateOption?: (searchKeyword: string, filteredData: InputItemDataType[]) => boolean;
 }
+/**
+ * Single item selector with text box input.
+ *
+ * @see https://rsuitejs.com/components/input-picker
+ */
 declare const InputPicker: PickerComponent<InputPickerProps>;
 export default InputPicker;

package/esm/InputPicker/InputPicker.js

@@ -24,6 +24,11 @@ import Tag from '../Tag';
 import InputAutosize from './InputAutosize';
 import InputSearch from './InputSearch';
 import InputPickerContext from './InputPickerContext';
+/**
+ * Single item selector with text box input.
+ *
+ * @see https://rsuitejs.com/components/input-picker
+ */
 var InputPicker = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _merge;
   var _props$as = props.as,

package/esm/List/List.d.ts

@@ -10,5 +10,9 @@ export interface ListProps extends WithAsProps, SortConfig {
 export interface ListComponent extends RsRefForwardingComponent<'div', ListProps> {
     Item: typeof ListItem;
 }
+/**
+ * The `List` component is used to specify the layout of the list.
+ * @see https://rsuitejs.com/components/list
+ */
 declare const List: ListComponent;
 export default List;

package/esm/List/List.js

@@ -7,6 +7,10 @@ import useSortHelper from './helper/useSortHelper';
 import { mergeRefs, useClassNames } from '../utils';
 import ListContext from './ListContext';
 import ListItem from './ListItem';
+/**
+ * The `List` component is used to specify the layout of the list.
+ * @see https://rsuitejs.com/components/list
+ */
 var List = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/List/ListItem.d.ts

@@ -7,5 +7,9 @@ export interface ListItemProps extends WithAsProps, React.HTMLAttributes<HTMLEle
     disabled?: boolean;
     size?: 'lg' | 'md' | 'sm';
 }
+/**
+ * The `List.Item` component is used to specify the layout of the list item.
+ * @see https://rsuitejs.com/components/list
+ */
 declare const ListItem: React.ForwardRefExoticComponent<ListItemProps & React.RefAttributes<HTMLDivElement>>;
 export default ListItem;

package/esm/List/ListItem.js

@@ -6,6 +6,10 @@ import PropTypes from 'prop-types';
 import { useContext, useEffect, useRef } from 'react';
 import { mergeRefs, useClassNames } from '../utils';
 import ListContext from './ListContext';
+/**
+ * The `List.Item` component is used to specify the layout of the list item.
+ * @see https://rsuitejs.com/components/list
+ */
 var ListItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Loader/Loader.d.ts

@@ -16,5 +16,9 @@ export interface LoaderProps extends WithAsProps {
     /** A loader can have different sizes */
     size?: TypeAttributes.Size;
 }
+/**
+ * The `Loader` component is used to indicate the loading state of a page or a section.
+ * @see https://rsuitejs.com/components/loader
+ */
 declare const Loader: RsRefForwardingComponent<'div', LoaderProps>;
 export default Loader;

package/esm/Loader/Loader.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
+/**
+ * The `Loader` component is used to indicate the loading state of a page or a section.
+ * @see https://rsuitejs.com/components/loader
+ */
 var Loader = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/MaskedInput/TextMask.d.ts

@@ -32,6 +32,10 @@ export declare type TextMaskProps = TextMaskBaseProps & React.HTMLAttributes<HTM
     readOnly?: boolean;
     disabled?: boolean;
 };
+/**
+ * The `TextMask` component is used to format the user input data.
+ * @see https://rsuitejs.com/components/input/#masked-input
+ */
 declare const TextMask: React.ForwardRefExoticComponent<TextMaskBaseProps & React.HTMLAttributes<HTMLInputElement> & {
     /** Custom rendering DOM */
     render?: ((ref: React.Ref<HTMLInputElement>, props: React.HTMLAttributes<HTMLInputElement>) => any) | undefined;

package/esm/MaskedInput/TextMask.js

@@ -16,6 +16,11 @@ var defaultRender = function defaultRender(ref, props) {
     ref: ref
   }, props));
 };
+
+/**
+ * The `TextMask` component is used to format the user input data.
+ * @see https://rsuitejs.com/components/input/#masked-input
+ */
 var TextMask = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var mask = props.mask,
     _props$guide = props.guide,

package/esm/MaskedInput/createTextMaskInputElement.js

@@ -5,11 +5,9 @@ import isNumber from 'lodash/isNumber';
 import adjustCaretPosition from './adjustCaretPosition';
 import conformToMask from './conformToMask';
 import { convertMaskToPlaceholder, processCaretTraps, defaultPlaceholderChar } from './utilities';
+import safeSetSelection from '../utils/safeSetSelection';
 var emptyString = '';
-var strNone = 'none';
 var strObject = 'object';
-var isAndroid = typeof navigator !== 'undefined' && /Android/i.test(navigator.userAgent);
-var defer = typeof requestAnimationFrame !== 'undefined' ? requestAnimationFrame : setTimeout;
 export default function createTextMaskInputElement(config) {
   // Anything that we will need to keep between `update` calls, we will store in this `state` object.
   var state = {
@@ -141,7 +139,7 @@ export default function createTextMaskInputElement(config) {
         // indicate rejection. Or return just a string when there are no piped characters.
         // If the `pipe` returns `false` or a string, the block below turns it into an object that the rest
         // of the code can work with.
-        if (pipeResults === false) {
+        if (typeof pipeResults === 'boolean' && pipeResults === false) {
           // If the `pipe` rejects `conformedValue`, we use the `previousConformedValue`, and set `rejected` to `true`.
           pipeResults = {
             value: previousConformedValue,
@@ -186,22 +184,14 @@ export default function createTextMaskInputElement(config) {
         return;
       }
       inputElement.value = inputElementValue; // set the input value
-      safeSetSelection(inputElement, adjustedCaretPosition); // adjust caret position
+
+      if (typeof adjustedCaretPosition === 'number') {
+        safeSetSelection(inputElement, adjustedCaretPosition, adjustedCaretPosition); // adjust caret position
+      }
     }
   };
 }
 
-function safeSetSelection(element, selectionPosition) {
-  if (document.activeElement === element) {
-    if (isAndroid) {
-      defer(function () {
-        return element.setSelectionRange(selectionPosition, selectionPosition, strNone);
-      }, 0);
-    } else {
-      element.setSelectionRange(selectionPosition, selectionPosition, strNone);
-    }
-  }
-}
 function getSafeRawValue(inputValue) {
   if (isString(inputValue)) {
     return inputValue;

package/esm/Message/Message.d.ts

@@ -24,5 +24,9 @@ export interface MessageProps extends WithAsProps {
     /** Callback after the message is removed */
     onClose?: (event?: React.MouseEvent<HTMLButtonElement>) => void;
 }
+/**
+ * The `Message` component is used to display important messages to users.
+ * @see https://rsuitejs.com/components/message
+ */
 declare const Message: RsRefForwardingComponent<'div', MessageProps>;
 export default Message;

package/esm/Message/Message.js

@@ -8,6 +8,10 @@ import PropTypes from 'prop-types';
 import { useClassNames, useTimeout, MESSAGE_STATUS_ICONS, STATUS, useIsMounted } from '../utils';
 import CloseButton from '../CloseButton';
 import ToastContext from '../toaster/ToastContext';
+/**
+ * The `Message` component is used to display important messages to users.
+ * @see https://rsuitejs.com/components/message
+ */
 var Message = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/esm/Modal/Modal.d.ts

@@ -35,5 +35,9 @@ interface ModalComponent extends RsRefForwardingComponent<'div', ModalProps> {
     Footer: typeof ModalFooter;
     Dialog: typeof ModalDialog;
 }
+/**
+ * The `Modal` component is used to show content in a layer above the app.
+ * @see https://rsuitejs.com/components/modal
+ */
 declare const Modal: ModalComponent;
 export default Modal;

package/esm/Modal/Modal.js

@@ -22,6 +22,10 @@ import useUniqueId from '../utils/useUniqueId';
 import deprecatePropType from '../utils/deprecatePropType';
 import DrawerContext from '../Drawer/DrawerContext';
 var modalSizes = ['xs', 'sm', 'md', 'lg', 'full'];
+/**
+ * The `Modal` component is used to show content in a layer above the app.
+ * @see https://rsuitejs.com/components/modal
+ */
 var Modal = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _prefix;
   var className = props.className,

package/esm/MultiCascader/MultiCascader.d.ts

@@ -34,5 +34,9 @@ export interface MultiCascaderProps<T = ValueType> extends FormControlPickerProp
     /** Asynchronously load the children of the tree node. */
     getChildren?: (node: ItemDataType) => ItemDataType[] | Promise<ItemDataType[]>;
 }
+/**
+ * The `MultiCascader` component is used to select multiple values from cascading options.
+ * @see https://rsuitejs.com/components/multi-cascader/
+ */
 declare const MultiCascader: PickerComponent<MultiCascaderProps>;
 export default MultiCascader;

package/esm/MultiCascader/MultiCascader.js

@@ -15,6 +15,11 @@ import { getColumnsAndPaths } from '../Cascader/utils';
 import { createChainedFunction, mergeRefs, getSafeRegExpString, useClassNames, useCustom, useUpdateEffect } from '../utils';
 import { PickerToggle, PickerOverlay, SearchBar, SelectedElement, PickerToggleTrigger, usePickerClassName, usePublicMethods, useToggleKeyDownEvent, useFocusItemValue, pickTriggerPropKeys, omitTriggerPropKeys, listPickerPropTypes } from '../Picker';
 var emptyArray = [];
+
+/**
+ * The `MultiCascader` component is used to select multiple values from cascading options.
+ * @see https://rsuitejs.com/components/multi-cascader/
+ */
 var MultiCascader = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _selectedPaths;
   var _props$as = props.as,

package/esm/Nav/Nav.d.ts

@@ -27,5 +27,9 @@ interface NavComponent extends RsRefForwardingComponent<'div', NavProps> {
     Item: typeof NavItem;
     Menu: typeof NavMenu;
 }
+/**
+ * The `Nav` component is used to create navigation links.
+ * @see https://rsuitejs.com/components/nav
+ */
 declare const Nav: NavComponent;
 export default Nav;