rsuite 5.47.0 → 5.48.0

package/cjs/MultiCascader/MultiCascader.js

@@ -21,6 +21,11 @@ var _utils2 = require("../Cascader/utils");
 var _utils3 = require("../utils");
 var _Picker = require("../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.default.forwardRef(function (props, ref) {
   var _selectedPaths;
   var _props$as = props.as,

package/cjs/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;

package/cjs/Nav/Nav.js

@@ -26,6 +26,10 @@ var _SidenavDropdownItem = _interopRequireDefault(require("../Sidenav/SidenavDro
 var _NavbarItem = _interopRequireDefault(require("../Navbar/NavbarItem"));
 var _SidenavItem = _interopRequireDefault(require("../Sidenav/SidenavItem"));
 var _useInternalId = _interopRequireDefault(require("../utils/useInternalId"));
+/**
+ * The `Nav` component is used to create navigation links.
+ * @see https://rsuitejs.com/components/nav
+ */
 var Nav = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Nav/NavDropdown.d.ts

@@ -60,8 +60,9 @@ export interface NavDropdownComponent extends RsRefForwardingComponent<'div', Na
 }
 /**
  * @private this component is not supposed to be used directly
- *          Instead it's rendered by a <Nav.Menu> call
+ *          Instead it's rendered by a `<Nav.Menu>` call
  *
+ * @example
  * <Nav>
  *   <Nav.Menu> -> This will render <NavDropdown> component
  *   </Nav.Menu>

package/cjs/Nav/NavDropdown.js

@@ -22,8 +22,9 @@ var _NavDropdownMenu = _interopRequireDefault(require("./NavDropdownMenu"));
 var _NavDropdownToggle = _interopRequireDefault(require("./NavDropdownToggle"));
 /**
  * @private this component is not supposed to be used directly
- *          Instead it's rendered by a <Nav.Menu> call
+ *          Instead it's rendered by a `<Nav.Menu>` call
  *
+ * @example
  * <Nav>
  *   <Nav.Menu> -> This will render <NavDropdown> component
  *   </Nav.Menu>

package/cjs/Nav/NavItem.d.ts

@@ -20,9 +20,12 @@ export interface NavItemProps<T = string> extends WithAsProps, Omit<React.HTMLAt
     onSelect?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
 }
 /**
- * The <Nav.Item> API
- * When used as direct child of <Nav>, render the NavItem
- * When used within a <Nav.Menu>, render the NavDropdownItem
+ * The `Nav.Item` component is used to create navigation links.
+ *
+ * - When used as direct child of `<Nav>`, render the NavItem
+ * - When used within a `<Nav.Menu>`, render the NavDropdownItem
+ * @see https://rsuitejs.com/components/nav
+ *
  */
 declare const NavItem: RsRefForwardingComponent<'a', NavItemProps>;
 export default NavItem;

package/cjs/Nav/NavItem.js

@@ -15,9 +15,12 @@ var _SafeAnchor = _interopRequireDefault(require("../SafeAnchor"));
 var _utils = require("../utils");
 var _NavContext = _interopRequireDefault(require("./NavContext"));
 /**
- * The <Nav.Item> API
- * When used as direct child of <Nav>, render the NavItem
- * When used within a <Nav.Menu>, render the NavDropdownItem
+ * The `Nav.Item` component is used to create navigation links.
+ *
+ * - When used as direct child of `<Nav>`, render the NavItem
+ * - When used within a `<Nav.Menu>`, render the NavDropdownItem
+ * @see https://rsuitejs.com/components/nav
+ *
  */
 var NavItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var nav = (0, _react.useContext)(_NavContext.default);

package/cjs/Nav/NavMenu.d.ts

@@ -30,9 +30,12 @@ export declare type NavMenuAction = {
     };
 };
 /**
- * The <Nav.Menu> API
- * When used as direct child of <Nav>, render the NavDropdown
- * When used within another <Nav.Menu>, render the NavDropdownMenu
+ * The `Nav.Menu` component is used to create navigation menus.
+ *
+ * - When used as direct child of `<Nav>`, render the NavDropdown
+ * - When used within another `<Nav.Menu>`, render the NavDropdownMenu
+ *
+ * @see https://rsuitejs.com/components/nav
  */
 declare const NavMenu: React.ForwardRefExoticComponent<NavMenuProps & React.RefAttributes<any>>;
 export default NavMenu;

package/cjs/Nav/NavMenu.js

@@ -47,9 +47,12 @@ var reducer = function reducer(state, action) {
 };
 
 /**
- * The <Nav.Menu> API
- * When used as direct child of <Nav>, render the NavDropdown
- * When used within another <Nav.Menu>, render the NavDropdownMenu
+ * The `Nav.Menu` component is used to create navigation menus.
+ *
+ * - When used as direct child of `<Nav>`, render the NavDropdown
+ * - When used within another `<Nav.Menu>`, render the NavDropdownMenu
+ *
+ * @see https://rsuitejs.com/components/nav
  */
 var NavMenu = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var parentNavMenu = (0, _react.useContext)(NavMenuContext);

package/cjs/Navbar/Navbar.d.ts

@@ -20,5 +20,9 @@ interface NavbarComponent extends RsRefForwardingComponent<'div', NavbarProps> {
     Body: typeof NavbarBody;
     Brand: typeof NavbarBrand;
 }
+/**
+ * The `Navbar` component is used to create a navigation header.
+ * @see https://rsuitejs.com/components/navbar
+ */
 declare const Navbar: NavbarComponent;
 export default Navbar;

package/cjs/Navbar/Navbar.js

@@ -13,6 +13,10 @@ var _NavbarBrand = _interopRequireDefault(require("./NavbarBrand"));
 var _utils = require("../utils");
 var NavbarContext = /*#__PURE__*/_react.default.createContext(false);
 exports.NavbarContext = NavbarContext;
+/**
+ * The `Navbar` component is used to create a navigation header.
+ * @see https://rsuitejs.com/components/navbar
+ */
 var Navbar = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$as = props.as,

package/cjs/Notification/Notification.d.ts

@@ -22,5 +22,10 @@ export interface NotificationProps extends WithAsProps {
     /** Callback after the message is removed */
     onClose?: (event?: React.MouseEvent<HTMLButtonElement>) => void;
 }
+/**
+ * The `Notification` component is used to display global messages and notifications.
+ *
+ * @see https://rsuitejs.com/components/notification
+ */
 declare const Notification: RsRefForwardingComponent<'div', NotificationProps>;
 export default Notification;

package/cjs/Notification/Notification.js

@@ -14,6 +14,11 @@ var _utils = require("../utils");
 var _CloseButton = _interopRequireDefault(require("../CloseButton"));
 var _ToastContext = _interopRequireDefault(require("../toaster/ToastContext"));
 var _templateObject, _templateObject2;
+/**
+ * The `Notification` component is used to display global messages and notifications.
+ *
+ * @see https://rsuitejs.com/components/notification
+ */
 var Notification = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Overlay/Overlay.d.ts

@@ -38,5 +38,9 @@ export declare const overlayPropTypes: {
     onExiting: PropTypes.Requireable<(...args: any[]) => any>;
     onExited: PropTypes.Requireable<(...args: any[]) => any>;
 };
+/**
+ * Overlay is a powerful component that helps you create floating components.
+ * @private
+ */
 declare const Overlay: React.ForwardRefExoticComponent<OverlayProps & React.RefAttributes<unknown>>;
 export default Overlay;

package/cjs/Overlay/Overlay.js

@@ -33,6 +33,11 @@ var overlayPropTypes = {
   onExiting: _propTypes.default.func,
   onExited: _propTypes.default.func
 };
+
+/**
+ * Overlay is a powerful component that helps you create floating components.
+ * @private
+ */
 exports.overlayPropTypes = overlayPropTypes;
 var Overlay = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _useContext = (0, _react.useContext)(_OverlayContext.default),

package/cjs/Overlay/OverlayTrigger.d.ts

@@ -78,5 +78,9 @@ export interface OverlayTriggerHandle {
     open: (delay?: number) => void;
     close: (delay?: number) => void;
 }
+/**
+ * OverlayTrigger is used to display floating elements on another component.
+ * @private
+ */
 declare const OverlayTrigger: React.ForwardRefExoticComponent<OverlayTriggerProps & React.RefAttributes<OverlayTriggerHandle>>;
 export default OverlayTrigger;

package/cjs/Overlay/OverlayTrigger.js

@@ -58,6 +58,11 @@ function onMouseEventHandler(handler, event, delay) {
   }
 }
 var defaultTrigger = ['hover', 'focus'];
+
+/**
+ * OverlayTrigger is used to display floating elements on another component.
+ * @private
+ */
 var OverlayTrigger = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _useContext = (0, _react.useContext)(_OverlayContext.default),
     overlayContainer = _useContext.overlayContainer;
@@ -188,17 +193,6 @@ var OverlayTrigger = /*#__PURE__*/_react.default.forwardRef(function (props, ref
       handleClose();
     }
   }, [handleClose]);
-
-  /**
-   * Toggle open and closed state.
-   */
-  var handleOpenState = (0, _react.useCallback)(function () {
-    if (open) {
-      handleCloseWhenLeave();
-    } else {
-      handleOpen();
-    }
-  }, [open, handleCloseWhenLeave, handleOpen]);
   var handleDelayedOpen = (0, _react.useCallback)(function () {
     mouseEnter.current = true;
     if (!enterable) {
@@ -215,6 +209,17 @@ var OverlayTrigger = /*#__PURE__*/_react.default.forwardRef(function (props, ref
     }
     handleOpen();
   }, [enterable, open, handleOpen]);
+
+  /**
+   * Toggle open and closed state.
+   */
+  var handleOpenState = (0, _react.useCallback)(function () {
+    if (open) {
+      handleCloseWhenLeave();
+    } else {
+      handleDelayedOpen();
+    }
+  }, [open, handleCloseWhenLeave, handleDelayedOpen]);
   var handleDelayedClose = (0, _react.useCallback)(function () {
     mouseEnter.current = false;
     if (!enterable) {

package/cjs/Overlay/Position.d.ts

@@ -22,5 +22,9 @@ export interface PositionInstance {
     updatePosition?: () => void;
     child?: Element;
 }
+/**
+ * The `Position` component calculates the position of the child element.
+ * @private
+ */
 declare const Position: React.ForwardRefExoticComponent<PositionProps & React.RefAttributes<unknown>>;
 export default Position;

package/cjs/Overlay/Position.js

@@ -126,6 +126,10 @@ var usePosition = function usePosition(props, ref) {
   }, [updatePosition, placement]);
   return [position, updatePosition];
 };
+/**
+ * The `Position` component calculates the position of the child element.
+ * @private
+ */
 var Position = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var children = props.children,
     className = props.className,

package/cjs/Pagination/Pagination.d.ts

@@ -33,5 +33,10 @@ export interface PaginationProps extends WithAsProps {
     /** callback function for pagination clicked */
     onSelect?: (eventKey: string | number, event: React.MouseEvent) => void;
 }
+/**
+ * Pagination component for displaying page numbers.
+ *
+ * @see https://rsuitejs.com/components/pagination
+ */
 declare const Pagination: RsRefForwardingComponent<'div', PaginationProps>;
 export default Pagination;

package/cjs/Pagination/Pagination.js

@@ -25,6 +25,11 @@ var PAGINATION_ICONS = {
   first: /*#__PURE__*/_react.default.createElement(_PageTop.default, null),
   last: /*#__PURE__*/_react.default.createElement(_PageEnd.default, null)
 };
+/**
+ * Pagination component for displaying page numbers.
+ *
+ * @see https://rsuitejs.com/components/pagination
+ */
 var Pagination = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Panel/Panel.d.ts

@@ -26,5 +26,9 @@ export interface PanelProps<T = string | number> extends WithAsProps, AnimationE
     /** callback function for the panel clicked */
     onSelect?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
 }
+/**
+ * The `Panel` component is used to display content that can be collapsed.
+ * @see https://rsuitejs.com/components/panel
+ */
 declare const Panel: RsRefForwardingComponent<'div', PanelProps>;
 export default Panel;

package/cjs/Panel/Panel.js

@@ -14,6 +14,10 @@ var _AngleDown = _interopRequireDefault(require("@rsuite/icons/legacy/AngleDown"
 var _Collapse = _interopRequireDefault(require("../Animation/Collapse"));
 var _utils = require("../utils");
 var _PanelGroup = require("../PanelGroup");
+/**
+ * The `Panel` component is used to display content that can be collapsed.
+ * @see https://rsuitejs.com/components/panel
+ */
 var Panel = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/PanelGroup/PanelGroup.d.ts

@@ -21,5 +21,9 @@ interface PanelGroupContext {
     onGroupSelect?: (activeKey: KeyType | undefined, event: React.MouseEvent) => void;
 }
 export declare const PanelGroupContext: React.Context<PanelGroupContext>;
+/**
+ * The `PanelGroup` component is used to display content that can be collapsed.
+ * @see https://rsuitejs.com/components/panel
+ */
 declare const PanelGroup: React.ForwardRefExoticComponent<PanelGroupProps<KeyType> & React.RefAttributes<unknown>>;
 export default PanelGroup;

package/cjs/PanelGroup/PanelGroup.js

@@ -11,6 +11,11 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var PanelGroupContext = /*#__PURE__*/_react.default.createContext({});
+
+/**
+ * The `PanelGroup` component is used to display content that can be collapsed.
+ * @see https://rsuitejs.com/components/panel
+ */
 exports.PanelGroupContext = PanelGroupContext;
 var PanelGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,

package/cjs/Placeholder/Placeholder.d.ts

@@ -7,5 +7,9 @@ export interface Placeholder extends RsRefForwardingComponent<'div', Placeholder
     Grid: typeof PlaceholderGrid;
     Graph: typeof PlaceholderGraph;
 }
+/**
+ * The `Placeholder` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 declare const Placeholder: Placeholder;
 export default Placeholder;

package/cjs/Placeholder/Placeholder.js

@@ -7,6 +7,10 @@ exports.default = void 0;
 var _PlaceholderGraph = _interopRequireDefault(require("./PlaceholderGraph"));
 var _PlaceholderGrid = _interopRequireDefault(require("./PlaceholderGrid"));
 var _PlaceholderParagraph = _interopRequireDefault(require("./PlaceholderParagraph"));
+/**
+ * The `Placeholder` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 var Placeholder = _PlaceholderParagraph.default;
 Placeholder.Paragraph = _PlaceholderParagraph.default;
 Placeholder.Grid = _PlaceholderGrid.default;

package/cjs/Placeholder/PlaceholderGraph.d.ts

@@ -5,5 +5,9 @@ export interface PlaceholderGraphProps extends WithAsProps {
     /** Placeholder status */
     active?: boolean;
 }
+/**
+ * The `Placeholder.Graph` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 declare const PlaceholderGraph: RsRefForwardingComponent<'div', PlaceholderGraphProps>;
 export default PlaceholderGraph;

package/cjs/Placeholder/PlaceholderGraph.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 `Placeholder.Graph` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 var PlaceholderGraph = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Placeholder/PlaceholderGrid.d.ts

@@ -7,5 +7,9 @@ export interface PlaceholderGridProps extends WithAsProps {
     /** Placeholder status */
     active?: boolean;
 }
+/**
+ * The `Placeholder.Grid` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 declare const PlaceholderGrid: RsRefForwardingComponent<'div', PlaceholderGridProps>;
 export default PlaceholderGrid;

package/cjs/Placeholder/PlaceholderGrid.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _classnames = _interopRequireDefault(require("classnames"));
 var _utils = require("../utils");
+/**
+ * The `Placeholder.Grid` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 var PlaceholderGrid = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Placeholder/PlaceholderParagraph.d.ts

@@ -7,5 +7,9 @@ export interface PlaceholderParagraphProps extends WithAsProps {
     /** Placeholder status */
     active?: boolean;
 }
+/**
+ * The `Placeholder.Paragraph` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 declare const PlaceholderParagraph: RsRefForwardingComponent<'div', PlaceholderParagraphProps>;
 export default PlaceholderParagraph;

package/cjs/Placeholder/PlaceholderParagraph.js

@@ -10,6 +10,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `Placeholder.Paragraph` component is used to display the loading state of the block.
+ * @see https://rsuitejs.com/components/placeholder
+ */
 var PlaceholderParagraph = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Plaintext/Plaintext.d.ts

@@ -6,7 +6,8 @@ export interface PlaintextProps extends WithAsProps {
     localeKey?: LocaleKey;
 }
 /**
- *  Make the component display in plain text, and display default characters when there is no children.
+ * Make the component display in plain text, and display default characters when there is no children.
+ * @private
  */
 declare const Plaintext: React.ForwardRefExoticComponent<PlaintextProps & React.RefAttributes<unknown>>;
 export default Plaintext;

package/cjs/Plaintext/Plaintext.js

@@ -9,7 +9,8 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _utils = require("../utils");
 /**
- *  Make the component display in plain text, and display default characters when there is no children.
+ * Make the component display in plain text, and display default characters when there is no children.
+ * @private
  */
 var Plaintext = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _useCustom = (0, _utils.useCustom)('Plaintext'),
@@ -31,7 +32,9 @@ var Plaintext = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var classes = merge(className, withClassPrefix({
     empty: !children
   }));
-  return /*#__PURE__*/_react.default.createElement(Component, (0, _extends2.default)({}, rest, {
+  return /*#__PURE__*/_react.default.createElement(Component, (0, _extends2.default)({
+    role: "text"
+  }, rest, {
     ref: ref,
     className: classes
   }), children ? children : placeholder);

package/cjs/Popover/Popover.d.ts

@@ -10,5 +10,9 @@ export interface PopoverProps extends WithAsProps {
     /** Whether show the arrow indicator */
     arrow?: boolean;
 }
+/**
+ * The `Popover` component is used to display a popup window for a target component.
+ * @see https://rsuitejs.com/components/popover
+ */
 declare const Popover: RsRefForwardingComponent<'div', PopoverProps>;
 export default Popover;

package/cjs/Popover/Popover.js

@@ -11,6 +11,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _templateObject, _templateObject2, _templateObject3;
+/**
+ * The `Popover` component is used to display a popup window for a target component.
+ * @see https://rsuitejs.com/components/popover
+ */
 var Popover = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Progress/Progress.d.ts

@@ -5,5 +5,9 @@ export interface Progress extends RsRefForwardingComponent<'div', ProgressLinePr
     Line: typeof ProgressLine;
     Circle: typeof ProgressCircle;
 }
+/**
+ * The `Progress` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress
+ */
 declare const Progress: Progress;
 export default Progress;

package/cjs/Progress/Progress.js

@@ -6,6 +6,10 @@ exports.__esModule = true;
 exports.default = void 0;
 var _ProgressCircle = _interopRequireDefault(require("./ProgressCircle"));
 var _ProgressLine = _interopRequireDefault(require("./ProgressLine"));
+/**
+ * The `Progress` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress
+ */
 var Progress = _ProgressLine.default;
 Progress.Line = _ProgressLine.default;
 Progress.Circle = _ProgressCircle.default;

package/cjs/Progress/ProgressCircle.d.ts

@@ -21,5 +21,9 @@ export interface ProgressCircleProps extends WithAsProps {
     /** Progress status */
     status?: 'success' | 'fail' | 'active';
 }
+/**
+ * The `Progress.Circle` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress/#circle
+ */
 declare const ProgressCircle: RsRefForwardingComponent<'div', ProgressCircleProps>;
 export default ProgressCircle;

package/cjs/Progress/ProgressCircle.js

@@ -10,6 +10,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `Progress.Circle` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress/#circle
+ */
 var ProgressCircle = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/cjs/Progress/ProgressLine.d.ts

@@ -17,5 +17,9 @@ export interface ProgressLineProps extends WithAsProps {
     /**  The progress bar is displayed vertically */
     vertical?: boolean;
 }
+/**
+ * The `Progress.Line` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress/#line
+ */
 declare const ProgressLine: RsRefForwardingComponent<'div', ProgressLineProps>;
 export default ProgressLine;

package/cjs/Progress/ProgressLine.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 `Progress.Line` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress/#line
+ */
 var ProgressLine = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _lineInnerStyle, _percentStyle, _withClassPrefix;
   var _props$as = props.as,

package/cjs/Radio/Radio.d.ts

@@ -29,5 +29,9 @@ export interface RadioProps<T = ValueType> extends WithAsProps, Omit<React.HTMLA
     /** Callback function with value changed */
     onChange?: (value: T | undefined, checked: boolean, event: React.ChangeEvent<HTMLInputElement>) => void;
 }
+/**
+ * The `Radio` component is a simple radio button.
+ * @see https://rsuitejs.com/components/radio
+ */
 declare const Radio: React.ForwardRefExoticComponent<RadioProps<ValueType> & React.RefAttributes<unknown>>;
 export default Radio;

package/cjs/Radio/Radio.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _RadioGroup = require("../RadioGroup/RadioGroup");
 var _utils = require("../utils");
+/**
+ * The `Radio` component is a simple radio button.
+ * @see https://rsuitejs.com/components/radio
+ */
 var Radio = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _useContext = (0, _react.useContext)(_RadioGroup.RadioContext),
     groupValue = _useContext.value,

package/cjs/RadioGroup/RadioGroup.d.ts

@@ -22,5 +22,9 @@ export interface RadioGroupProps<T = ValueType> extends WithAsProps, FormControl
     children?: React.ReactNode;
 }
 export declare const RadioContext: React.Context<RadioContextProps>;
+/**
+ * The `RadioGroup` component is used to group a collection of `Radio` components.
+ * @see https://rsuitejs.com/components/radio/#radio-group
+ */
 declare const RadioGroup: RsRefForwardingComponent<'div', RadioGroupProps>;
 export default RadioGroup;

package/cjs/RadioGroup/RadioGroup.js

@@ -12,6 +12,11 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _Plaintext = _interopRequireDefault(require("../Plaintext"));
 var RadioContext = /*#__PURE__*/_react.default.createContext({});
+
+/**
+ * The `RadioGroup` component is used to group a collection of `Radio` components.
+ * @see https://rsuitejs.com/components/radio/#radio-group
+ */
 exports.RadioContext = RadioContext;
 var RadioGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,

package/cjs/RadioTileGroup/RadioTileGroup.d.ts

@@ -19,5 +19,10 @@ export interface RadioTileGroupProps<T = ValueType> extends WithAsProps, FormCon
     children?: React.ReactNode;
 }
 export declare const RadioTileContext: React.Context<RadioTileContextProps>;
+/**
+ * The `RadioTileGroup` component is used to group a collection of `RadioTile` components.
+ * @version 5.35.0
+ * @see https://rsuitejs.com/components/radio-tile/
+ */
 declare const RadioTileGroup: RsRefForwardingComponent<'div', RadioTileGroupProps>;
 export default RadioTileGroup;