rsuite 5.46.1 → 5.48.0

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

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

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

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

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

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

@@ -4,7 +4,8 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import { useClassNames, useCustom } from '../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.forwardRef(function (props, ref) {
   var _useCustom = useCustom('Plaintext'),
@@ -26,7 +27,9 @@ var Plaintext = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var classes = merge(className, withClassPrefix({
     empty: !children
   }));
-  return /*#__PURE__*/React.createElement(Component, _extends({}, rest, {
+  return /*#__PURE__*/React.createElement(Component, _extends({
+    role: "text"
+  }, rest, {
     ref: ref,
     className: classes
   }), children ? children : placeholder);

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

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

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

@@ -1,6 +1,10 @@
 'use client';
 import ProgressCircle from './ProgressCircle';
 import ProgressLine from './ProgressLine';
+/**
+ * The `Progress` component is used to display the progress of current operation.
+ * @see https://rsuitejs.com/components/progress
+ */
 var Progress = ProgressLine;
 Progress.Line = ProgressLine;
 Progress.Circle = ProgressCircle;

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

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

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

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

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

@@ -5,6 +5,10 @@ import React, { useCallback, useContext } from 'react';
 import PropTypes from 'prop-types';
 import { RadioContext } from '../RadioGroup/RadioGroup';
 import { useClassNames, useControlled, partitionHTMLProps, TypeChecker } from '../utils';
+/**
+ * The `Radio` component is a simple radio button.
+ * @see https://rsuitejs.com/components/radio
+ */
 var Radio = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _useContext = useContext(RadioContext),
     groupValue = _useContext.value,

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

@@ -6,6 +6,11 @@ import PropTypes from 'prop-types';
 import { useClassNames, useControlled } from '../utils';
 import Plaintext from '../Plaintext';
 export var RadioContext = /*#__PURE__*/React.createContext({});
+
+/**
+ * The `RadioGroup` component is used to group a collection of `Radio` components.
+ * @see https://rsuitejs.com/components/radio/#radio-group
+ */
 var RadioGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/RadioTile/RadioTile.d.ts

@@ -21,5 +21,10 @@ export interface RadioTileProps<T = ValueType> extends WithAsProps, Omit<React.H
     /** Callback function with value changed */
     onChange?: (value?: T, event?: React.ChangeEvent<HTMLInputElement>) => void;
 }
+/**
+ * A series of selectable tile components that behave like Radio.
+ * @version 5.35.0
+ * @see https://rsuitejs.com/components/radio-tile/
+ */
 declare const RadioTile: React.ForwardRefExoticComponent<RadioTileProps<ValueType> & React.RefAttributes<unknown>>;
 export default RadioTile;

package/esm/RadioTile/RadioTile.js

@@ -8,6 +8,11 @@ import Stack from '../Stack';
 import { RadioTileContext } from '../RadioTileGroup/RadioTileGroup';
 import { useClassNames, useControlled, partitionHTMLProps } from '../utils';
 import useUniqueId from '../utils/useUniqueId';
+/**
+ * A series of selectable tile components that behave like Radio.
+ * @version 5.35.0
+ * @see https://rsuitejs.com/components/radio-tile/
+ */
 var RadioTile = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _useContext = useContext(RadioTileContext),
     groupValue = _useContext.value,

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

package/esm/RadioTileGroup/RadioTileGroup.js

@@ -6,6 +6,12 @@ import PropTypes from 'prop-types';
 import { useClassNames, useControlled } from '../utils';
 import Stack from '../Stack';
 export var RadioTileContext = /*#__PURE__*/React.createContext({});
+
+/**
+ * The `RadioTileGroup` component is used to group a collection of `RadioTile` components.
+ * @version 5.35.0
+ * @see https://rsuitejs.com/components/radio-tile/
+ */
 var RadioTileGroup = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? Stack : _props$as,

package/esm/RangeSlider/RangeSlider.d.ts

@@ -7,6 +7,10 @@ export declare type RangeSliderProps = SliderProps<Range> & {
      */
     constraint?: (range: Range) => boolean;
 };
+/**
+ * The `RangeSlider` component is used to select a range from a given numerical range.
+ * @see https://rsuitejs.com/components/slider/
+ */
 declare const RangeSlider: React.ForwardRefExoticComponent<SliderProps<Range> & {
     /**
      * Add constraint to validate before onChange is dispatched

package/esm/RangeSlider/RangeSlider.js

@@ -14,6 +14,11 @@ import Graduated from '../Slider/Graduated';
 import { precisionMath, checkValue } from '../Slider/utils';
 import { tupleType } from '../utils/propTypeChecker';
 var defaultDefaultValue = [0, 0];
+
+/**
+ * The `RangeSlider` component is used to select a range from a given numerical range.
+ * @see https://rsuitejs.com/components/slider/
+ */
 var RangeSlider = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var ariaLabel = props['aria-label'],
     ariaLabelledby = props['aria-labelledby'],

package/esm/Rate/Rate.d.ts

@@ -14,5 +14,9 @@ export interface RateProps<T = number> extends WithAsProps, FormControlBaseProps
     renderCharacter?: (value: number, index: number) => React.ReactNode;
     onChangeActive?: (value: T, event: React.SyntheticEvent) => void;
 }
+/**
+ * The `Rate` component is used for rating. It can be used to evaluate the quality of the content.
+ * @see https://rsuitejs.com/components/rate/
+ */
 declare const Rate: RsRefForwardingComponent<'ul', RateProps>;
 export default Rate;

package/esm/Rate/Rate.js

@@ -9,6 +9,10 @@ import { useClassNames, useControlled, shallowEqualArray, SIZE, KEY_VALUES } fro
 import { transformValueToCharacterMap, transformCharacterMapToValue } from './utils';
 import Character from './Character';
 import Plaintext from '../Plaintext';
+/**
+ * The `Rate` component is used for rating. It can be used to evaluate the quality of the content.
+ * @see https://rsuitejs.com/components/rate/
+ */
 var Rate = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'ul' : _props$as,

package/esm/Ripple/Ripple.d.ts

@@ -3,5 +3,9 @@ import { WithAsProps } from '../@types/common';
 export interface RippleProps extends WithAsProps {
     onMouseDown?: (position: any, event: React.MouseEvent) => void;
 }
+/**
+ * The `Ripple` component is used to implement the ripple effect.
+ * @private
+ */
 declare const Ripple: React.ForwardRefExoticComponent<RippleProps & React.RefAttributes<HTMLSpanElement>>;
 export default Ripple;

package/esm/Ripple/Ripple.js

@@ -21,6 +21,11 @@ var getPosition = function getPosition(target, event) {
     top: offsetY - radius
   };
 };
+
+/**
+ * The `Ripple` component is used to implement the ripple effect.
+ * @private
+ */
 var Ripple = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _useCustom = useCustom(),
     disableRipple = _useCustom.disableRipple;

package/esm/Row/Row.d.ts

@@ -2,5 +2,9 @@ import { WithAsProps, RsRefForwardingComponent } from '../@types/common';
 export interface RowProps extends WithAsProps {
     gutter?: number;
 }
+/**
+ * The `Row` component is used for layout and grids.
+ * @see https://rsuitejs.com/components/grid
+ */
 declare const Row: RsRefForwardingComponent<'div', RowProps>;
 export default Row;

package/esm/Row/Row.js

@@ -4,6 +4,10 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React from 'react';
 import PropTypes from 'prop-types';
 import { ReactChildren, useClassNames } from '../utils';
+/**
+ * The `Row` component is used for layout and grids.
+ * @see https://rsuitejs.com/components/grid
+ */
 var Row = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/SafeAnchor/SafeAnchor.d.ts

@@ -6,5 +6,9 @@ export interface SafeAnchorProps extends WithAsProps, React.HTMLAttributes<HTMLE
     /** A link can show it is currently unable to be interacted with */
     disabled?: boolean;
 }
+/**
+ * A SafeAnchor is a wrapper around the `<a>` HTML element.
+ * @private
+ */
 declare const SafeAnchor: RsRefForwardingComponent<'a', SafeAnchorProps>;
 export default SafeAnchor;

package/esm/SafeAnchor/SafeAnchor.js

@@ -6,6 +6,11 @@ import PropTypes from 'prop-types';
 function isTrivialHref(href) {
   return !href || href.trim() === '#';
 }
+
+/**
+ * A SafeAnchor is a wrapper around the `<a>` HTML element.
+ * @private
+ */
 var SafeAnchor = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'a' : _props$as,

package/esm/Schema/Schema.d.ts

@@ -1,4 +1,10 @@
 import { SchemaModel, StringType, NumberType, ArrayType, DateType, ObjectType, BooleanType, MixedType } from 'schema-typed';
+/**
+ * SchemaTyped is a wrapper of schema-typed library to provide a more friendly API.
+ * It is used to validate the data of the model.
+ *
+ * @see https://github.com/rsuite/schema-typed#schema-typed
+ */
 declare const SchemaTyped: {
     Model: typeof SchemaModel;
     Types: {

package/esm/Schema/Schema.js

@@ -1,5 +1,12 @@
 'use client';
 import { SchemaModel, StringType, NumberType, ArrayType, DateType, ObjectType, BooleanType, MixedType } from 'schema-typed';
+
+/**
+ * SchemaTyped is a wrapper of schema-typed library to provide a more friendly API.
+ * It is used to validate the data of the model.
+ *
+ * @see https://github.com/rsuite/schema-typed#schema-typed
+ */
 var SchemaTyped = {
   Model: SchemaModel,
   Types: {

package/esm/SelectPicker/SelectPicker.d.ts

@@ -54,5 +54,9 @@ export interface SelectPickerComponent {
     displayName?: string;
     propTypes?: React.WeakValidationMap<SelectPickerProps<any>>;
 }
+/**
+ * The `SelectPicker` component is used to select an item from a list of data.
+ * @see https://rsuitejs.com/components/select-picker/
+ */
 declare const SelectPicker: SelectPickerComponent;
 export default SelectPicker;

package/esm/SelectPicker/SelectPicker.js

@@ -14,6 +14,10 @@ import { createChainedFunction, useCustom, useClassNames, useControlled, mergeRe
 import { getDataGroupBy } from '../utils/getDataGroupBy';
 import { DropdownMenu, DropdownMenuItem, PickerToggle, PickerToggleTrigger, PickerOverlay, SearchBar, useFocusItemValue, usePickerClassName, useSearch, usePublicMethods, useToggleKeyDownEvent, pickTriggerPropKeys, omitTriggerPropKeys, listPickerPropTypes } from '../Picker';
 var emptyArray = [];
+/**
+ * The `SelectPicker` component is used to select an item from a list of data.
+ * @see https://rsuitejs.com/components/select-picker/
+ */
 var SelectPicker = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Sidebar/Sidebar.d.ts

@@ -5,5 +5,9 @@ export interface SidebarProps extends WithAsProps {
     /** Sidebar can be collapsed */
     collapsible?: boolean;
 }
+/**
+ * The `Sidebar` component for use with the `Container` component.
+ * @see https://rsuitejs.com/components/container/
+ */
 declare const Sidebar: RsRefForwardingComponent<'aside', SidebarProps>;
 export default Sidebar;

package/esm/Sidebar/Sidebar.js

@@ -5,6 +5,10 @@ import React, { useContext, useEffect } from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames } from '../utils';
 import { ContainerContext } from '../Container/Container';
+/**
+ * The `Sidebar` component for use with the `Container` component.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Sidebar = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'aside' : _props$as,

package/esm/Sidenav/Sidenav.d.ts

@@ -45,5 +45,9 @@ export interface SidenavComponent extends RsRefForwardingComponent<'div', Sidena
     Body: typeof SidenavBody;
     Toggle: typeof SidenavToggle;
 }
+/**
+ * The `Sidenav` component is an encapsulation of the page sidebar `Nav`.
+ * @see https://rsuitejs.com/components/sidenav/
+ */
 declare const Sidenav: SidenavComponent;
 export default Sidenav;

package/esm/Sidenav/Sidenav.js

@@ -13,6 +13,11 @@ import { useClassNames, useControlled, mergeRefs } from '../utils';
 import deprecatePropType from '../utils/deprecatePropType';
 export var SidenavContext = /*#__PURE__*/React.createContext(null);
 var emptyArray = [];
+
+/**
+ * The `Sidenav` component is an encapsulation of the page sidebar `Nav`.
+ * @see https://rsuitejs.com/components/sidenav/
+ */
 var Sidenav = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'nav' : _props$as,

package/esm/Sidenav/SidenavBody.d.ts

@@ -1,4 +1,9 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type SidenavBodyProps = ComponentProps;
+/**
+ * The `Sidenav.Body` component for use with the `Sidenav` component.
+ *
+ * @see https://rsuitejs.com/components/sidenav
+ */
 declare const SidenavBody: import("../@types/common").RsRefForwardingComponent<"div", ComponentProps>;
 export default SidenavBody;

package/esm/Sidenav/SidenavBody.js

@@ -1,5 +1,10 @@
 'use client';
 import createComponent from '../utils/createComponent';
+/**
+ * The `Sidenav.Body` component for use with the `Sidenav` component.
+ *
+ * @see https://rsuitejs.com/components/sidenav
+ */
 var SidenavBody = createComponent({
   name: 'SidenavBody'
 });

package/esm/Sidenav/SidenavHeader.d.ts

@@ -1,4 +1,9 @@
 import { ComponentProps } from '../utils/createComponent';
 export declare type SidenavHeaderProps = ComponentProps;
+/**
+ * The `Sidenav.Header` component for use with the `Sidenav` component.
+ *
+ * @see https://rsuitejs.com/components/sidenav
+ */
 declare const SidenavHeader: import("../@types/common").RsRefForwardingComponent<"div", ComponentProps>;
 export default SidenavHeader;

package/esm/Sidenav/SidenavHeader.js

@@ -1,5 +1,10 @@
 'use client';
 import createComponent from '../utils/createComponent';
+/**
+ * The `Sidenav.Header` component for use with the `Sidenav` component.
+ *
+ * @see https://rsuitejs.com/components/sidenav
+ */
 var SidenavHeader = createComponent({
   name: 'SidenavHeader'
 });

package/esm/Slider/Slider.d.ts

@@ -76,5 +76,10 @@ export declare const sliderPropTypes: {
     renderTooltip: PropTypes.Requireable<(...args: any[]) => any>;
     getAriaValueText: PropTypes.Requireable<(...args: any[]) => any>;
 };
+/**
+ * A Slider is an interface for users to adjust a value in a specific range.
+ *
+ * @see https://rsuitejs.com/components/slider
+ */
 declare const Slider: React.ForwardRefExoticComponent<SliderProps<number> & React.RefAttributes<unknown>>;
 export default Slider;

package/esm/Slider/Slider.js

@@ -37,6 +37,12 @@ export var sliderPropTypes = {
   renderTooltip: PropTypes.func,
   getAriaValueText: PropTypes.func
 };
+
+/**
+ * A Slider is an interface for users to adjust a value in a specific range.
+ *
+ * @see https://rsuitejs.com/components/slider
+ */
 var Slider = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var ariaLabel = props['aria-label'],
     ariaLabelledby = props['aria-labelledby'],

package/esm/Stack/Stack.d.ts

@@ -30,5 +30,11 @@ export interface StackProps extends WithAsProps {
 export interface StackComponent extends RsRefForwardingComponent<'div', StackProps> {
     Item: typeof StackItem;
 }
+/**
+ * The `Stack` component is a quick layout component through Flexbox,
+ * supporting vertical and horizontal stacking, custom spacing and line wrapping.
+ *
+ * @see https://rsuitejs.com/components/stack
+ */
 declare const Stack: StackComponent;
 export default Stack;

package/esm/Stack/Stack.js

@@ -5,6 +5,12 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { useClassNames, useCustom, isSupportFlexGap } from '../utils';
 import StackItem from './StackItem';
+/**
+ * The `Stack` component is a quick layout component through Flexbox,
+ * supporting vertical and horizontal stacking, custom spacing and line wrapping.
+ *
+ * @see https://rsuitejs.com/components/stack
+ */
 var Stack = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _itemStyles;
   var _props$as = props.as,

package/esm/Stack/StackItem.d.ts

@@ -9,6 +9,11 @@ export interface StackItemProps extends WithAsProps {
     basis?: React.CSSProperties['flexBasis'];
     order?: React.CSSProperties['order'];
 }
+/**
+ * The `Stack.Item` component is used to set the layout of the child element in the `Stack` component.
+ *
+ * @see https://rsuitejs.com/components/stack
+ */
 declare function StackItem(props: StackItemProps): JSX.Element;
 declare namespace StackItem {
     var displayName: string;

package/esm/Stack/StackItem.js

@@ -3,6 +3,11 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import React from 'react';
 import PropTypes from 'prop-types';
+/**
+ * The `Stack.Item` component is used to set the layout of the child element in the `Stack` component.
+ *
+ * @see https://rsuitejs.com/components/stack
+ */
 export default function StackItem(props) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,