rsuite 5.47.0 → 5.48.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [5.48.1](https://github.com/rsuite/rsuite/compare/v5.48.0...v5.48.1) (2023-12-22)
+
+### Bug Fixes
+
+- **build:** fix environment variable undefined error when building ([#3521](https://github.com/rsuite/rsuite/issues/3521)) ([8efa27b](https://github.com/rsuite/rsuite/commit/8efa27b69233d4cd72a4b09dbbd080b15db7d1c0))
+- **DatePicker:** fix `menuStyle` prop not working ([#3509](https://github.com/rsuite/rsuite/issues/3509)) ([aa816be](https://github.com/rsuite/rsuite/commit/aa816be89573f8483335736b67365a0b13848ecf))
+- **useMediaQuery:** fix MediaQueryList not updating status when triggering change event ([#3503](https://github.com/rsuite/rsuite/issues/3503)) ([06b79dd](https://github.com/rsuite/rsuite/commit/06b79dda26ced54b070cda3fd6d70f96a7a7e373))
+
+# [5.48.0](https://github.com/rsuite/rsuite/compare/v5.47.0...v5.48.0) (2023-12-14)
+
+### Bug Fixes
+
+- **Whisper:** fix delay and other related props not working ([#3499](https://github.com/rsuite/rsuite/issues/3499)) ([a54aee1](https://github.com/rsuite/rsuite/commit/a54aee1f37e05fcf4618077a9a59165051de2a5a))
+
+### Features
+
+- **DateInput:** add support for DateInput ([#3492](https://github.com/rsuite/rsuite/issues/3492)) ([3095c03](https://github.com/rsuite/rsuite/commit/3095c037090b8366f39a98e9b275cd732e4dd069))
+- **useMediaQuery:** add a CSS media query hook ([#3234](https://github.com/rsuite/rsuite/issues/3234)) ([d2bfdd6](https://github.com/rsuite/rsuite/commit/d2bfdd661a0f6c75de3906dc6fba3d8f41176551))
+- add annotations and link for components using JSDoc format ([#3498](https://github.com/rsuite/rsuite/issues/3498)) ([39d4e5f](https://github.com/rsuite/rsuite/commit/39d4e5ff8491472fa3ef93bb0af9f14ec6ca6037))
+
 # [5.47.0](https://github.com/rsuite/rsuite/compare/v5.46.1...v5.47.0) (2023-12-08)
 
 ### Bug Fixes

package/DateInput/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "rsuite/DateInput",
+  "private": true,
+  "main": "../cjs/DateInput/index.js",
+  "module": "../esm/DateInput/index.js",
+  "types": "../esm/DateInput/index.d.ts"
+}

package/README.md

@@ -75,7 +75,7 @@ function App() {
 You can go through [full documentation][rsuite-doc-guide] or start with following sections
 
 - [Quick start][rsuite-doc-guide]
-- [Customizing themes][rsuite-doc-guide-themes]
+- [Less Customization][rsuite-doc-guide-themes]
 - [Internationalization][rsuite-doc-guide-intl]
 - [Right-to-left][rsuite-doc-guide-rtl]
 - [Components][rsuite-components-overview]
@@ -155,7 +155,7 @@ React Suite is [MIT licensed][license]. Copyright (c) 2016-present, HYPERS.
 [rsuite-design]: https://rsuitejs.com/design/default
 [live-preview-on-codesandbox]: https://codesandbox.io/s/rsuite-template-5vq6zo2z5l
 [rsuite-doc-guide]: https://rsuitejs.com/en/guide/introduction
-[rsuite-doc-guide-themes]: https://rsuitejs.com/en/guide/customization
+[rsuite-doc-guide-themes]: https://rsuitejs.com/en/guide/customization-less
 [rsuite-doc-guide-intl]: https://rsuitejs.com/en/guide/intl
 [rsuite-doc-guide-rtl]: https://rsuitejs.com/en/guide/rtl
 [rsuite-components-overview]: https://rsuitejs.com/en/components/overview

package/cjs/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/cjs/Affix/Affix.js

@@ -99,6 +99,13 @@ function useFixed(offset, containerOffset, props) {
   (0, _utils.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.default.forwardRef(function (props, ref) {
   var _merge;
   var _props$as = props.as,

package/cjs/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/cjs/Animation/Bounce.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _Transition = _interopRequireDefault(require("./Transition"));
 var _utils = require("../utils");
+/**
+ * Bounce animation component
+ * @see https://rsuitejs.com/components/animation/#bounce
+ */
 var Bounce = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var _ref$timeout = _ref.timeout,
     timeout = _ref$timeout === void 0 ? 300 : _ref$timeout,

package/cjs/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/cjs/Animation/Collapse.js

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

package/cjs/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/cjs/Animation/Fade.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _Transition = _interopRequireDefault(require("./Transition"));
 var _utils = require("../utils");
+/**
+ * Fade animation component
+ * @see https://rsuitejs.com/components/animation/#fade
+ */
 var Fade = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var _ref$timeout = _ref.timeout,
     timeout = _ref$timeout === void 0 ? 300 : _ref$timeout,

package/cjs/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/cjs/Animation/Slide.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _Transition = _interopRequireDefault(require("./Transition"));
 var _utils = require("../utils");
+/**
+ * Slide animation component
+ * @see https://rsuitejs.com/components/animation/#slide
+ */
 var Slide = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var _ref$timeout = _ref.timeout,
     timeout = _ref$timeout === void 0 ? 300 : _ref$timeout,

package/cjs/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/cjs/Animation/Transition.js

@@ -39,6 +39,10 @@ var transitionPropTypes = (0, _extends2.default)({}, _utils2.animationPropTypes,
   enteringClassName: _propTypes.default.string
 });
 exports.transitionPropTypes = transitionPropTypes;
+/**
+ * A Transition component for animation.
+ * @see https://rsuitejs.com/components/animation/#transition
+ */
 var Transition = /*#__PURE__*/function (_React$Component) {
   (0, _inheritsLoose2.default)(Transition, _React$Component);
   function Transition(props) {

package/cjs/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/cjs/AutoComplete/AutoComplete.js

@@ -18,6 +18,9 @@ var _Picker = require("../Picker");
 var _utils3 = require("./utils");
 var _Plaintext = _interopRequireDefault(require("../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/cjs/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/cjs/Avatar/Avatar.js

@@ -13,6 +13,10 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _AvatarGroup = require("../AvatarGroup/AvatarGroup");
 var _templateObject;
+/**
+ * The Avatar component is used to represent user or brand.
+ * @see https://rsuitejs.com/components/avatar
+ */
 var Avatar = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'avatar' : _props$classPrefix,

package/cjs/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/cjs/AvatarGroup/AvatarGroup.js

@@ -11,6 +11,11 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var AvatarGroupContext = /*#__PURE__*/_react.default.createContext({});
+
+/**
+ * The AvatarGroup component is used to represent a collection of avatars.
+ * @see https://rsuitejs.com/components/avatar
+ */
 exports.AvatarGroupContext = AvatarGroupContext;
 var AvatarGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,

package/cjs/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/cjs/Badge/Badge.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 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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/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/cjs/Breadcrumb/Breadcrumb.js

@@ -13,6 +13,10 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _BreadcrumbItem = _interopRequireDefault(require("./BreadcrumbItem"));
 var _templateObject;
+/**
+ * The Breadcrumb component is used to indicate the current page location and navigate.
+ * @see https://rsuitejs.com/components/breadcrumb
+ */
 var Breadcrumb = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'nav' : _props$as,

package/cjs/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/cjs/Breadcrumb/BreadcrumbItem.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _SafeAnchor = _interopRequireDefault(require("../SafeAnchor"));
 var _utils = require("../utils");
+/**
+ * The `<Breadcrumb.Item>` component is used to specify each section of the Breadcrumb.
+ * @see https://rsuitejs.com/components/breadcrumb
+ */
 var BreadcrumbItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? props.href ? _SafeAnchor.default : 'span' : _props$as,

package/cjs/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/cjs/Button/Button.js

@@ -15,6 +15,10 @@ var _SafeAnchor = _interopRequireDefault(require("../SafeAnchor"));
 var _Ripple = _interopRequireDefault(require("../Ripple"));
 var _utils = require("../utils");
 var _templateObject, _templateObject2, _templateObject3;
+/**
+ * The Button component is used to trigger a custom action.
+ * @see https://rsuitejs.com/components/button
+ */
 var Button = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var as = props.as,
     active = props.active,

package/cjs/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/cjs/ButtonGroup/ButtonGroup.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _ButtonGroupContext = _interopRequireDefault(require("./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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/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/cjs/ButtonToolbar/ButtonToolbar.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _Stack = _interopRequireDefault(require("../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.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$classPrefix = props.classPrefix,

package/cjs/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/cjs/Calendar/Calendar.js

@@ -15,6 +15,10 @@ var _Button = _interopRequireDefault(require("../Button"));
 var _CustomProvider = require("../CustomProvider");
 var _utils = require("../utils");
 var _useCalendarDate2 = _interopRequireDefault(require("./useCalendarDate"));
+/**
+ * The Calendar component is used to select dates.
+ * @see https://rsuitejs.com/components/calendar
+ */
 var Calendar = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? _CalendarContainer.default : _props$as,

package/cjs/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/cjs/Carousel/Carousel.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _classnames = _interopRequireDefault(require("classnames"));
 var _utils = require("../utils");
+/**
+ * The Carousel component is used to display a series of content.
+ * @see https://rsuitejs.com/components/carousel
+ */
 var Carousel = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _sliderStyles, _ref;
   var _props$as = props.as,

package/cjs/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/cjs/Cascader/Cascader.js

@@ -22,6 +22,11 @@ var _utils2 = require("../utils");
 var _Picker = require("../Picker");
 var _useMap = require("../utils/useMap");
 var emptyArray = [];
+
+/**
+ * The `Cascader` component displays a hierarchical list of options.
+ * @see https://rsuitejs.com/components/cascader
+ */
 var Cascader = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/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/cjs/CheckPicker/CheckPicker.js

@@ -23,6 +23,10 @@ var _getDataGroupBy = require("../utils/getDataGroupBy");
 var _Picker = require("../Picker");
 var _templateObject;
 var emptyArray = [];
+/**
+ * A component for selecting checkable items in a dropdown list.
+ * @see https://rsuitejs.com/components/check-picker
+ */
 var CheckPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/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/cjs/CheckTree/index.js

@@ -9,6 +9,10 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 var _react = _interopRequireWildcard(require("react"));
 var _CheckTreePicker = _interopRequireDefault(require("../CheckTreePicker"));
 var _TreeContext = _interopRequireDefault(require("../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.default.forwardRef(function (props, ref) {
   var contextValue = (0, _react.useMemo)(function () {
     return {

package/cjs/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/cjs/CheckTreePicker/CheckTreePicker.js

@@ -27,6 +27,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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/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/cjs/Checkbox/Checkbox.js

@@ -13,6 +13,10 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _CheckboxGroup = require("../CheckboxGroup");
 var _templateObject, _templateObject2, _templateObject3;
+/**
+ * The Checkbox component is used for selecting multiple options from a set.
+ * @see https://rsuitejs.com/components/checkbox
+ */
 var Checkbox = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var checkboxGroupContext = (0, _react.useContext)(_CheckboxGroup.CheckboxGroupContext);
   var _ref = checkboxGroupContext !== null && checkboxGroupContext !== void 0 ? checkboxGroupContext : {},

package/cjs/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/cjs/CheckboxGroup/CheckboxGroup.js

@@ -14,6 +14,10 @@ var _remove = _interopRequireDefault(require("lodash/remove"));
 var _utils = require("../utils");
 var _Plaintext = _interopRequireDefault(require("../Plaintext"));
 var _CheckboxGroupContext = require("./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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/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/cjs/Col/Col.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _omit = _interopRequireDefault(require("lodash/omit"));
 var _utils = require("../utils");
+/**
+ * The `Col` component is used for layout and grids.
+ * @see https://rsuitejs.com/en/components/grid
+ */
 var Col = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,