rsuite 5.47.0 → 5.48.0

package/esm/Affix/Affix.d.ts

@@ -9,5 +9,11 @@ export interface AffixProps extends WithAsProps {
     /** Callback after the offset changes. */
     onOffsetChange?: (offset?: Offset) => void;
 }
+/**
+ * Components such as navigation, buttons, etc. can be fixed in the visible range.
+ * Commonly used for pages with long content, fixed the specified elements in the visible range of the page to assist in quick operation.
+ *
+ * @see https://rsuitejs.com/components/affix/
+ */
 declare const Affix: RsRefForwardingComponent<'div', AffixProps>;
 export default Affix;

package/esm/Affix/Affix.js

@@ -93,6 +93,13 @@ function useFixed(offset, containerOffset, props) {
   useEventListener(window, 'scroll', handleScroll, false);
   return fixed;
 }
+
+/**
+ * Components such as navigation, buttons, etc. can be fixed in the visible range.
+ * Commonly used for pages with long content, fixed the specified elements in the visible range of the page to assist in quick operation.
+ *
+ * @see https://rsuitejs.com/components/affix/
+ */
 var Affix = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _merge;
   var _props$as = props.as,

package/esm/Animation/Bounce.d.ts

@@ -1,5 +1,9 @@
 import React from 'react';
 import { TransitionProps } from './Transition';
 export declare type BounceProps = TransitionProps;
+/**
+ * Bounce animation component
+ * @see https://rsuitejs.com/components/animation/#bounce
+ */
 declare const Bounce: React.ForwardRefExoticComponent<TransitionProps & React.RefAttributes<any>>;
 export default Bounce;

package/esm/Animation/Bounce.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import Transition from './Transition';
 import { useClassNames } from '../utils';
+/**
+ * Bounce animation component
+ * @see https://rsuitejs.com/components/animation/#bounce
+ */
 var Bounce = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var _ref$timeout = _ref.timeout,
     timeout = _ref$timeout === void 0 ? 300 : _ref$timeout,

package/esm/Animation/Collapse.d.ts

@@ -10,5 +10,9 @@ export interface CollapseProps extends TransitionProps {
     /** Function that returns the height or width of the animating DOM node */
     getDimensionValue?: (dimension: DIMENSION, elem: Element) => number;
 }
+/**
+ * A Collapse animation component.
+ * @see https://rsuitejs.com/components/animation/#collapse
+ */
 declare const Collapse: React.ForwardRefExoticComponent<CollapseProps & React.RefAttributes<any>>;
 export default Collapse;

package/esm/Animation/Collapse.js

@@ -30,6 +30,11 @@ function getScrollDimensionValue(elem, dimension) {
   var value = get(elem, "scroll" + capitalize(dimension));
   return value + "px";
 }
+
+/**
+ * A Collapse animation component.
+ * @see https://rsuitejs.com/components/animation/#collapse
+ */
 var Collapse = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var className = props.className,
     _props$timeout = props.timeout,

package/esm/Animation/Fade.d.ts

@@ -1,5 +1,9 @@
 import React from 'react';
 import { TransitionProps } from './Transition';
 export declare type FadeProps = TransitionProps;
+/**
+ * Fade animation component
+ * @see https://rsuitejs.com/components/animation/#fade
+ */
 declare const Fade: React.ForwardRefExoticComponent<TransitionProps & React.RefAttributes<any>>;
 export default Fade;

package/esm/Animation/Fade.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import Transition from './Transition';
 import { useClassNames } from '../utils';
+/**
+ * Fade animation component
+ * @see https://rsuitejs.com/components/animation/#fade
+ */
 var Fade = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var _ref$timeout = _ref.timeout,
     timeout = _ref$timeout === void 0 ? 300 : _ref$timeout,

package/esm/Animation/Slide.d.ts

@@ -3,5 +3,9 @@ import { TransitionProps } from './Transition';
 export interface SlideProps extends TransitionProps {
     placement?: 'top' | 'right' | 'bottom' | 'left';
 }
+/**
+ * Slide animation component
+ * @see https://rsuitejs.com/components/animation/#slide
+ */
 declare const Slide: React.ForwardRefExoticComponent<SlideProps & React.RefAttributes<any>>;
 export default Slide;

package/esm/Animation/Slide.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import Transition from './Transition';
 import { useClassNames } from '../utils';
+/**
+ * Slide animation component
+ * @see https://rsuitejs.com/components/animation/#slide
+ */
 var Slide = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var _ref$timeout = _ref.timeout,
     timeout = _ref$timeout === void 0 ? 300 : _ref$timeout,

package/esm/Animation/Transition.d.ts

@@ -56,6 +56,10 @@ export declare const transitionPropTypes: {
 declare type EventToken = {
     off: () => void;
 };
+/**
+ * A Transition component for animation.
+ * @see https://rsuitejs.com/components/animation/#transition
+ */
 declare class Transition extends React.Component<TransitionProps, TransitionState> {
     static propTypes: {
         animation: PropTypes.Requireable<boolean>;

package/esm/Animation/Transition.js

@@ -32,6 +32,10 @@ export var transitionPropTypes = _extends({}, animationPropTypes, {
   enteredClassName: PropTypes.string,
   enteringClassName: PropTypes.string
 });
+/**
+ * A Transition component for animation.
+ * @see https://rsuitejs.com/components/animation/#transition
+ */
 var Transition = /*#__PURE__*/function (_React$Component) {
   _inheritsLoose(Transition, _React$Component);
   function Transition(props) {

package/esm/AutoComplete/AutoComplete.d.ts

@@ -41,6 +41,9 @@ export interface AutoCompleteProps<T = ValueType> extends WithAsProps, FormContr
     renderMenuItem?: (label: React.ReactNode, item: ItemDataType) => React.ReactNode;
 }
 /**
+ * Autocomplete function of input field.
+ * @see https://rsuitejs.com/components/auto-complete
+ *
  * TODO: Remove unnecessary .rs-auto-complete element
  * TODO: role=combobox and aria-autocomplete on input element
  */

package/esm/AutoComplete/AutoComplete.js

@@ -12,6 +12,9 @@ import { PickerToggleTrigger, onMenuKeyDown, DropdownMenu, DropdownMenuItem, Pic
 import { transformData, shouldDisplay } from './utils';
 import Plaintext from '../Plaintext';
 /**
+ * Autocomplete function of input field.
+ * @see https://rsuitejs.com/components/auto-complete
+ *
  * TODO: Remove unnecessary .rs-auto-complete element
  * TODO: role=combobox and aria-autocomplete on input element
  */

package/esm/Avatar/Avatar.d.ts

@@ -26,5 +26,9 @@ export interface AvatarProps extends WithAsProps {
     /** This attribute defines an alternative text description of the image */
     alt?: string;
 }
+/**
+ * The Avatar component is used to represent user or brand.
+ * @see https://rsuitejs.com/components/avatar
+ */
 declare const Avatar: RsRefForwardingComponent<'div', AvatarProps>;
 export default Avatar;

package/esm/Avatar/Avatar.js

@@ -7,6 +7,10 @@ import React, { useContext } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import { AvatarGroupContext } from '../AvatarGroup/AvatarGroup';
+/**
+ * The Avatar component is used to represent user or brand.
+ * @see https://rsuitejs.com/components/avatar
+ */
 var Avatar = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'avatar' : _props$classPrefix,

package/esm/AvatarGroup/AvatarGroup.d.ts

@@ -11,5 +11,9 @@ export interface AvatarGroupProps extends WithAsProps {
 export declare const AvatarGroupContext: React.Context<{
     size?: TypeAttributes.Size | undefined;
 }>;
+/**
+ * The AvatarGroup component is used to represent a collection of avatars.
+ * @see https://rsuitejs.com/components/avatar
+ */
 declare const AvatarGroup: RsRefForwardingComponent<'div', AvatarGroupProps>;
 export default AvatarGroup;

package/esm/AvatarGroup/AvatarGroup.js

@@ -5,6 +5,11 @@ import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames, useCustom } from '../utils';
 export var AvatarGroupContext = /*#__PURE__*/React.createContext({});
+
+/**
+ * The AvatarGroup component is used to represent a collection of avatars.
+ * @see https://rsuitejs.com/components/avatar
+ */
 var AvatarGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Badge/Badge.d.ts

@@ -8,5 +8,9 @@ export interface BadgeProps extends WithAsProps {
     /** A badge can have different colors */
     color?: TypeAttributes.Color;
 }
+/**
+ * The Badge component is usually used to mark or highlight the status or quantity of an object.
+ * @see https://rsuitejs.com/components/badge
+ */
 declare const Badge: RsRefForwardingComponent<'div', BadgeProps>;
 export default Badge;

package/esm/Badge/Badge.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 Badge component is usually used to mark or highlight the status or quantity of an object.
+ * @see https://rsuitejs.com/components/badge
+ */
 var Badge = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Breadcrumb/Breadcrumb.d.ts

@@ -19,5 +19,9 @@ export interface BreadcrumbProps extends WithAsProps {
 export interface BreadcrumbComponent extends RsRefForwardingComponent<'ol', BreadcrumbProps> {
     Item: typeof BreadcrumbItem;
 }
+/**
+ * The Breadcrumb component is used to indicate the current page location and navigate.
+ * @see https://rsuitejs.com/components/breadcrumb
+ */
 declare const Breadcrumb: BreadcrumbComponent;
 export default Breadcrumb;

package/esm/Breadcrumb/Breadcrumb.js

@@ -7,6 +7,10 @@ import React, { useState, useCallback } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames, useCustom } from '../utils';
 import BreadcrumbItem from './BreadcrumbItem';
+/**
+ * The Breadcrumb component is used to indicate the current page location and navigate.
+ * @see https://rsuitejs.com/components/breadcrumb
+ */
 var Breadcrumb = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'nav' : _props$as,

package/esm/Breadcrumb/BreadcrumbItem.d.ts

@@ -6,5 +6,9 @@ export interface BreadcrumbItemProps extends WithAsProps<React.ElementType | str
     title?: string;
     target?: string;
 }
+/**
+ * The `<Breadcrumb.Item>` component is used to specify each section of the Breadcrumb.
+ * @see https://rsuitejs.com/components/breadcrumb
+ */
 declare const BreadcrumbItem: RsRefForwardingComponent<'a', BreadcrumbItemProps>;
 export default BreadcrumbItem;

package/esm/Breadcrumb/BreadcrumbItem.js

@@ -5,6 +5,10 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import SafeAnchor from '../SafeAnchor';
 import { useClassNames } from '../utils';
+/**
+ * The `<Breadcrumb.Item>` component is used to specify each section of the Breadcrumb.
+ * @see https://rsuitejs.com/components/breadcrumb
+ */
 var BreadcrumbItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? props.href ? SafeAnchor : 'span' : _props$as,

package/esm/Button/Button.d.ts

@@ -28,5 +28,9 @@ export interface ButtonProps extends WithAsProps, React.HTMLAttributes<HTMLEleme
     /** Defines HTML button type attribute */
     type?: 'button' | 'reset' | 'submit';
 }
+/**
+ * The Button component is used to trigger a custom action.
+ * @see https://rsuitejs.com/components/button
+ */
 declare const Button: RsRefForwardingComponent<'button', ButtonProps>;
 export default Button;

package/esm/Button/Button.js

@@ -9,6 +9,10 @@ import { ButtonGroupContext } from '../ButtonGroup';
 import SafeAnchor from '../SafeAnchor';
 import Ripple from '../Ripple';
 import { isOneOf, useClassNames } from '../utils';
+/**
+ * The Button component is used to trigger a custom action.
+ * @see https://rsuitejs.com/components/button
+ */
 var Button = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var as = props.as,
     active = props.active,

package/esm/ButtonGroup/ButtonGroup.d.ts

@@ -17,5 +17,9 @@ export interface ButtonGroupProps extends WithAsProps {
     /** A button group can have different sizes */
     size?: TypeAttributes.Size;
 }
+/**
+ * The ButtonGroup component is used to group a series of buttons together in a single line or column.
+ * @see https://rsuitejs.com/components/button/#button-group
+ */
 declare const ButtonGroup: RsRefForwardingComponent<'div', ButtonGroupProps>;
 export default ButtonGroup;

package/esm/ButtonGroup/ButtonGroup.js

@@ -5,6 +5,10 @@ import React, { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import ButtonGroupContext from './ButtonGroupContext';
+/**
+ * The ButtonGroup component is used to group a series of buttons together in a single line or column.
+ * @see https://rsuitejs.com/components/button/#button-group
+ */
 var ButtonGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/ButtonToolbar/ButtonToolbar.d.ts

@@ -8,5 +8,9 @@ export interface ButtonToolbarProps extends WithAsProps {
      */
     role?: string;
 }
+/**
+ * The ButtonToolbar component is used to group a series of buttons together in a single line.
+ * @see https://rsuitejs.com/components/button/#button-toolbar
+ */
 declare const ButtonToolbar: RsRefForwardingComponent<typeof Stack, ButtonToolbarProps>;
 export default ButtonToolbar;

package/esm/ButtonToolbar/ButtonToolbar.js

@@ -5,6 +5,10 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import Stack from '../Stack';
+/**
+ * The ButtonToolbar component is used to group a series of buttons together in a single line.
+ * @see https://rsuitejs.com/components/button/#button-toolbar
+ */
 var ButtonToolbar = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var className = props.className,
     _props$classPrefix = props.classPrefix,

package/esm/Calendar/Calendar.d.ts

@@ -29,5 +29,9 @@ export interface CalendarProps extends WithAsProps {
     /** Custom cell classes base on it's date */
     cellClassName?: (date: Date) => string | undefined;
 }
+/**
+ * The Calendar component is used to select dates.
+ * @see https://rsuitejs.com/components/calendar
+ */
 declare const Calendar: RsRefForwardingComponent<typeof CalendarContainer, CalendarProps>;
 export default Calendar;

package/esm/Calendar/Calendar.js

@@ -9,6 +9,10 @@ import Button from '../Button';
 import { FormattedDate } from '../CustomProvider';
 import { useClassNames, useCustom } from '../utils';
 import useCalendarDate from './useCalendarDate';
+/**
+ * The Calendar component is used to select dates.
+ * @see https://rsuitejs.com/components/calendar
+ */
 var Calendar = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? CalendarContainer : _props$as,

package/esm/Carousel/Carousel.d.ts

@@ -20,5 +20,9 @@ export interface CarouselProps extends WithAsProps {
     /** Callback fired when a slide transition ends */
     onSlideEnd?: (index: number, event: React.TransitionEvent<HTMLDivElement>) => void;
 }
+/**
+ * The Carousel component is used to display a series of content.
+ * @see https://rsuitejs.com/components/carousel
+ */
 declare const Carousel: RsRefForwardingComponent<'div', CarouselProps>;
 export default Carousel;

package/esm/Carousel/Carousel.js

@@ -5,6 +5,10 @@ import React, { useState, useMemo, useCallback, useRef } from 'react';
 import PropTypes from 'prop-types';
 import classNames from 'classnames';
 import { useClassNames, useCustom, guid, ReactChildren, useTimeout, mergeRefs, useControlled, useUpdateEffect } from '../utils';
+/**
+ * The Carousel component is used to display a series of content.
+ * @see https://rsuitejs.com/components/carousel
+ */
 var Carousel = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _sliderStyles, _ref;
   var _props$as = props.as,

package/esm/Cascader/Cascader.d.ts

@@ -38,5 +38,9 @@ export interface CascaderComponent {
     displayName?: string;
     propTypes?: React.WeakValidationMap<CascaderProps<any>>;
 }
+/**
+ * The `Cascader` component displays a hierarchical list of options.
+ * @see https://rsuitejs.com/components/cascader
+ */
 declare const Cascader: CascaderComponent;
 export default Cascader;

package/esm/Cascader/Cascader.js

@@ -16,6 +16,11 @@ import { getSafeRegExpString, createChainedFunction, mergeRefs, useControlled, u
 import { PickerToggle, PickerOverlay, SearchBar, PickerToggleTrigger, usePickerClassName, usePublicMethods, useToggleKeyDownEvent, useFocusItemValue, pickTriggerPropKeys, omitTriggerPropKeys, listPickerPropTypes } from '../Picker';
 import { useMap } from '../utils/useMap';
 var emptyArray = [];
+
+/**
+ * The `Cascader` component displays a hierarchical list of options.
+ * @see https://rsuitejs.com/components/cascader
+ */
 var Cascader = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/CheckPicker/CheckPicker.d.ts

@@ -17,5 +17,9 @@ export interface CheckPickerComponent {
     displayName?: string;
     propTypes?: React.WeakValidationMap<CheckPickerProps<any>>;
 }
+/**
+ * A component for selecting checkable items in a dropdown list.
+ * @see https://rsuitejs.com/components/check-picker
+ */
 declare const CheckPicker: CheckPickerComponent;
 export default CheckPicker;

package/esm/CheckPicker/CheckPicker.js

@@ -17,6 +17,10 @@ import { createChainedFunction, useClassNames, shallowEqual, useCustom, useContr
 import { getDataGroupBy } from '../utils/getDataGroupBy';
 import { DropdownMenu, DropdownMenuCheckItem as DropdownMenuItem, PickerToggle, PickerOverlay, SearchBar, SelectedElement, PickerToggleTrigger, useFocusItemValue, usePickerClassName, useSearch, usePublicMethods, useToggleKeyDownEvent, pickTriggerPropKeys, omitTriggerPropKeys, listPickerPropTypes } from '../Picker';
 var emptyArray = [];
+/**
+ * A component for selecting checkable items in a dropdown list.
+ * @see https://rsuitejs.com/components/check-picker
+ */
 var CheckPicker = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/CheckTree/index.d.ts

@@ -7,5 +7,9 @@ export interface CheckTreeProps extends TreeBaseProps<ValueType>, FormControlPic
     /** Set the option value for the check box not to be rendered */
     uncheckableItemValues?: ValueType;
 }
+/**
+ * The `CheckTree` component is used for selecting multiple options which are organized in a tree structure.
+ * @see https://rsuitejs.com/components/check-tree
+ */
 declare const CheckTree: RsRefForwardingComponent<'div', CheckTreeProps>;
 export default CheckTree;

package/esm/CheckTree/index.js

@@ -3,6 +3,10 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 import React, { useMemo } from 'react';
 import CheckTreePicker from '../CheckTreePicker';
 import TreeContext from '../Tree/TreeContext';
+/**
+ * The `CheckTree` component is used for selecting multiple options which are organized in a tree structure.
+ * @see https://rsuitejs.com/components/check-tree
+ */
 var CheckTree = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var contextValue = useMemo(function () {
     return {

package/esm/CheckTreePicker/CheckTreePicker.d.ts

@@ -16,5 +16,10 @@ export interface CheckTreePickerProps<T = ValueType> extends TreeBaseProps<T, It
     /** Called when scrolling */
     onScroll?: (event: React.SyntheticEvent) => void;
 }
+/**
+ * The `CheckTreePicker` component is used for selecting multiple options which are organized in a tree structure.
+ *
+ * @see https://rsuitejs.com/components/check-tree-picker
+ */
 declare const CheckTreePicker: PickerComponent<CheckTreePickerProps>;
 export default CheckTreePicker;

package/esm/CheckTreePicker/CheckTreePicker.js

@@ -22,6 +22,12 @@ var emptyArray = [];
 var itemSize = function itemSize() {
   return 36;
 };
+
+/**
+ * The `CheckTreePicker` component is used for selecting multiple options which are organized in a tree structure.
+ *
+ * @see https://rsuitejs.com/components/check-tree-picker
+ */
 var CheckTreePicker = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Checkbox/Checkbox.d.ts

@@ -39,5 +39,9 @@ export interface CheckboxProps<V = ValueType> extends WithAsProps {
     /** Called when the user presses down a key. */
     onKeyDown?: (event: React.KeyboardEvent) => void;
 }
+/**
+ * The Checkbox component is used for selecting multiple options from a set.
+ * @see https://rsuitejs.com/components/checkbox
+ */
 declare const Checkbox: RsRefForwardingComponent<'div', CheckboxProps>;
 export default Checkbox;

package/esm/Checkbox/Checkbox.js

@@ -7,6 +7,10 @@ import React, { useContext, useCallback, useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useControlled, partitionHTMLProps, useClassNames, TypeChecker } from '../utils';
 import { CheckboxGroupContext } from '../CheckboxGroup';
+/**
+ * The Checkbox component is used for selecting multiple options from a set.
+ * @see https://rsuitejs.com/components/checkbox
+ */
 var Checkbox = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var checkboxGroupContext = useContext(CheckboxGroupContext);
   var _ref = checkboxGroupContext !== null && checkboxGroupContext !== void 0 ? checkboxGroupContext : {},

package/esm/CheckboxGroup/CheckboxGroup.d.ts

@@ -9,5 +9,9 @@ export interface CheckboxGroupProps<V = ValueType[]> extends WithAsProps, FormCo
     /** Inline layout */
     inline?: boolean;
 }
+/**
+ * The `CheckboxGroup` component is used for selecting multiple options which are unrelated.
+ * @see https://rsuitejs.com/components/checkbox/#checkbox-group
+ */
 declare const CheckboxGroup: RsRefForwardingComponent<'div', CheckboxGroupProps>;
 export default CheckboxGroup;

package/esm/CheckboxGroup/CheckboxGroup.js

@@ -8,6 +8,10 @@ import remove from 'lodash/remove';
 import { useClassNames, useControlled, shallowEqual } from '../utils';
 import Plaintext from '../Plaintext';
 import { CheckboxGroupContext } from './CheckboxGroupContext';
+/**
+ * The `CheckboxGroup` component is used for selecting multiple options which are unrelated.
+ * @see https://rsuitejs.com/components/checkbox/#checkbox-group
+ */
 var CheckboxGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Col/Col.d.ts

@@ -61,5 +61,9 @@ export interface ColProps extends WithAsProps {
     /** Hide column on Ultra large devices Desktops */
     xxlHidden?: boolean;
 }
+/**
+ * The `Col` component is used for layout and grids.
+ * @see https://rsuitejs.com/en/components/grid
+ */
 declare const Col: RsRefForwardingComponent<'div', ColProps>;
 export default Col;

package/esm/Col/Col.js

@@ -5,6 +5,10 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import omit from 'lodash/omit';
 import { useClassNames, COLUMN_SIZE } from '../utils';
+/**
+ * The `Col` component is used for layout and grids.
+ * @see https://rsuitejs.com/en/components/grid
+ */
 var Col = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Container/Container.d.ts

@@ -5,5 +5,9 @@ export declare const ContainerContext: React.Context<ContainerContextValue>;
 interface ContainerContextValue {
     setHasSidebar?: (value: boolean) => void;
 }
+/**
+ * The Container component is used to wrap content in a themed container with a max-width.
+ * @see https://rsuitejs.com/components/container
+ */
 declare const Container: React.ForwardRefExoticComponent<WithAsProps<React.ElementType<any>> & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
 export default Container;

package/esm/Container/Container.js

@@ -5,6 +5,10 @@ import React, { useState, useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 export var ContainerContext = /*#__PURE__*/React.createContext({});
+/**
+ * The Container component is used to wrap content in a themed container with a max-width.
+ * @see https://rsuitejs.com/components/container
+ */
 var Container = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'section' : _props$as,

package/esm/Content/Content.d.ts

@@ -1,6 +1,9 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type ContentProps = ComponentProps;
 /**
+ * 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/esm/Content/Content.js

@@ -1,6 +1,9 @@
 'use client';
 import createComponent from '../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/esm/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;