rsuite 5.47.0 → 5.48.0

package/cjs/RadioTileGroup/RadioTileGroup.js

@@ -12,6 +12,12 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _Stack = _interopRequireDefault(require("../Stack"));
 var RadioTileContext = /*#__PURE__*/_react.default.createContext({});
+
+/**
+ * The `RadioTileGroup` component is used to group a collection of `RadioTile` components.
+ * @version 5.35.0
+ * @see https://rsuitejs.com/components/radio-tile/
+ */
 exports.RadioTileContext = RadioTileContext;
 var RadioTileGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,

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

@@ -20,6 +20,11 @@ var _Graduated = _interopRequireDefault(require("../Slider/Graduated"));
 var _utils2 = require("../Slider/utils");
 var _propTypeChecker = require("../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.default.forwardRef(function (props, ref) {
   var ariaLabel = props['aria-label'],
     ariaLabelledby = props['aria-labelledby'],

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

@@ -15,6 +15,10 @@ var _utils = require("../utils");
 var _utils2 = require("./utils");
 var _Character = _interopRequireDefault(require("./Character"));
 var _Plaintext = _interopRequireDefault(require("../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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'ul' : _props$as,

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

@@ -27,6 +27,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.default.forwardRef(function (props, ref) {
   var _useCustom = (0, _utils.useCustom)(),
     disableRipple = _useCustom.disableRipple;

package/cjs/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/cjs/Row/Row.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 `Row` component is used for layout and grids.
+ * @see https://rsuitejs.com/components/grid
+ */
 var Row = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

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

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

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

@@ -4,6 +4,12 @@
 exports.__esModule = true;
 exports.default = void 0;
 var _schemaTyped = require("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: _schemaTyped.SchemaModel,
   Types: {

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

@@ -20,6 +20,10 @@ var _getDataGroupBy = require("../utils/getDataGroupBy");
 var _Picker = require("../Picker");
 var _templateObject;
 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.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

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

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _Container = require("../Container/Container");
+/**
+ * The `Sidebar` component for use with the `Container` component.
+ * @see https://rsuitejs.com/components/container/
+ */
 var Sidebar = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'aside' : _props$as,

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

@@ -20,6 +20,11 @@ var _deprecatePropType = _interopRequireDefault(require("../utils/deprecatePropT
 var SidenavContext = /*#__PURE__*/_react.default.createContext(null);
 exports.SidenavContext = SidenavContext;
 var emptyArray = [];
+
+/**
+ * The `Sidenav` component is an encapsulation of the page sidebar `Nav`.
+ * @see https://rsuitejs.com/components/sidenav/
+ */
 var Sidenav = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'nav' : _props$as,

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

@@ -5,6 +5,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `Sidenav.Body` component for use with the `Sidenav` component.
+ *
+ * @see https://rsuitejs.com/components/sidenav
+ */
 var SidenavBody = (0, _createComponent.default)({
   name: 'SidenavBody'
 });

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

@@ -5,6 +5,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `Sidenav.Header` component for use with the `Sidenav` component.
+ *
+ * @see https://rsuitejs.com/components/sidenav
+ */
 var SidenavHeader = (0, _createComponent.default)({
   name: 'SidenavHeader'
 });

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

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

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

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

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

@@ -8,6 +8,11 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("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
+ */
 function StackItem(props) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Steps/StepItem.d.ts

@@ -15,5 +15,10 @@ export interface StepItemProps extends WithAsProps {
     /** The title of Steps item */
     title?: React.ReactNode;
 }
+/**
+ * The `Step.Item` component is used to set the layout of the child element in the `Steps` component.
+ *
+ * @see https://rsuitejs.com/components/steps
+ */
 declare const StepItem: RsRefForwardingComponent<'div', StepItemProps>;
 export default StepItem;

package/cjs/Steps/StepItem.js

@@ -17,6 +17,11 @@ var STEP_STATUS_ICON = {
   process: null,
   error: /*#__PURE__*/_react.default.createElement(_Close.default, null)
 };
+/**
+ * The `Step.Item` component is used to set the layout of the child element in the `Steps` component.
+ *
+ * @see https://rsuitejs.com/components/steps
+ */
 var StepItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _withClassPrefix, _STEP_STATUS_ICON$sta;
   var _props$as = props.as,

package/cjs/Steps/Steps.d.ts

@@ -16,5 +16,10 @@ export interface StepsProps extends WithAsProps {
 interface StepsComponent extends RsRefForwardingComponent<'div', StepsProps> {
     Item: typeof StepItem;
 }
+/**
+ * The `Steps` component is used to guide users to complete tasks in accordance with the process.
+ *
+ * @see https://rsuitejs.com/components/steps
+ */
 declare const Steps: StepsComponent;
 export default Steps;

package/cjs/Steps/Steps.js

@@ -10,6 +10,11 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _StepItem = _interopRequireDefault(require("./StepItem"));
+/**
+ * The `Steps` component is used to guide users to complete tasks in accordance with the process.
+ *
+ * @see https://rsuitejs.com/components/steps
+ */
 var Steps = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Table/Table.d.ts

@@ -6,10 +6,27 @@ export interface CellProps<Row extends RowDataType> extends Omit<TableCellProps<
     /** Row Data */
     rowData?: Row;
 }
-declare const _default: (<Row extends RowDataType<any>, Key extends RowKeyType>(props: TableProps<Row, Key> & React.RefAttributes<TableInstance<Row, Key>>) => React.ReactElement<any, string | React.JSXElementConstructor<any>>) & {
+/**
+ * The `Table` component is used to display data in a table.
+ *
+ * @see https://rsuitejs.com/components/table/
+ */
+declare const Table: (<Row extends RowDataType<any>, Key extends RowKeyType>(props: TableProps<Row, Key> & React.RefAttributes<TableInstance<Row, Key>>) => React.ReactElement) & {
+    /**
+     * The `Table.Cell` component  is used to display data in a table cell.
+     */
     Cell: <Row_1 extends RowDataType<any>, Key_1 extends RowKeyType>(props: import("rsuite-table/lib/Cell").InnerCellProps<Row_1, Key_1> & React.RefAttributes<HTMLDivElement>) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+    /**
+     * The `Table.Column` component  is used to define a column in a table.
+     */
     Column: typeof Column;
+    /**
+     * The `Table.HeaderCell` component  is used to define a header cell in a table.
+     */
     HeaderCell: <Row_2 extends RowDataType<any>, Key_2 extends RowKeyType>(props: import("rsuite-table").HeaderCellProps<Row_2, Key_2> & React.RefAttributes<HTMLDivElement>) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+    /**
+     * The `Table.ColumnGroup` component  is used to define a column group in a table.
+     */
     ColumnGroup: React.ForwardRefExoticComponent<import("rsuite-table").ColumnGroupProps & React.RefAttributes<HTMLDivElement>>;
 };
-export default _default;
+export default Table;

package/cjs/Table/Table.js

@@ -24,10 +24,29 @@ var CustomTable = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     loadAnimation: loadAnimation
   }));
 });
-var _default = Object.assign(CustomTable, {
+
+/**
+ * The `Table` component is used to display data in a table.
+ *
+ * @see https://rsuitejs.com/components/table/
+ */
+var Table = Object.assign(CustomTable, {
+  /**
+   * The `Table.Cell` component  is used to display data in a table cell.
+   */
   Cell: _rsuiteTable.Cell,
+  /**
+   * The `Table.Column` component  is used to define a column in a table.
+   */
   Column: _rsuiteTable.Column,
+  /**
+   * The `Table.HeaderCell` component  is used to define a header cell in a table.
+   */
   HeaderCell: _rsuiteTable.HeaderCell,
+  /**
+   * The `Table.ColumnGroup` component  is used to define a column group in a table.
+   */
   ColumnGroup: _rsuiteTable.ColumnGroup
 });
+var _default = Table;
 exports.default = _default;

package/cjs/Tag/Tag.d.ts

@@ -12,5 +12,11 @@ export interface TagProps extends WithAsProps {
     /** Click the callback function for the Close button */
     onClose?: (event: React.MouseEvent<HTMLElement>) => void;
 }
+/**
+ * The `Tag` component is used to label and categorize.
+ * It can be used to mark the status of an object or classify it into different categories.
+ *
+ * @see https://rsuitejs.com/components/tag
+ */
 declare const Tag: RsRefForwardingComponent<'div', TagProps>;
 export default Tag;

package/cjs/Tag/Tag.js

@@ -12,6 +12,12 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _CloseButton = _interopRequireDefault(require("../CloseButton"));
 var _templateObject, _templateObject2;
+/**
+ * The `Tag` component is used to label and categorize.
+ * It can be used to mark the status of an object or classify it into different categories.
+ *
+ * @see https://rsuitejs.com/components/tag
+ */
 var Tag = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/TagGroup/TagGroup.d.ts

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

package/cjs/TagGroup/TagGroup.js

@@ -5,6 +5,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 exports.__esModule = true;
 exports.default = void 0;
 var _createComponent = _interopRequireDefault(require("../utils/createComponent"));
+/**
+ * The `TagGroup` component for use with the `Tag` component.
+ *
+ * @see https://rsuitejs.com/components/tag/
+ */
 var TagGroup = (0, _createComponent.default)({
   name: 'TagGroup'
 });

package/cjs/TagInput/index.d.ts

@@ -2,5 +2,10 @@ import { InputPickerProps } from '../InputPicker/InputPicker';
 import { TagOnlyProps } from '../InputPicker/InputPickerContext';
 import type { PickerComponent } from '../Picker/types';
 export declare type TagInputProps = Omit<InputPickerProps<readonly string[]>, 'data'> & Partial<TagOnlyProps>;
+/**
+ * The `TagInput` component is an enhancement of Input and supports input tags and management tags.
+ *
+ * @see https://rsuitejs.com/components/tag-input
+ */
 declare const TagInput: PickerComponent<TagInputProps>;
 export default TagInput;

package/cjs/TagInput/index.js

@@ -10,6 +10,11 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireWildcard(require("react"));
 var _InputPicker = _interopRequireDefault(require("../InputPicker/InputPicker"));
 var _InputPickerContext = _interopRequireDefault(require("../InputPicker/InputPickerContext"));
+/**
+ * The `TagInput` component is an enhancement of Input and supports input tags and management tags.
+ *
+ * @see https://rsuitejs.com/components/tag-input
+ */
 var TagInput = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$tagProps = props.tagProps,
     tagProps = _props$tagProps === void 0 ? {} : _props$tagProps,

package/cjs/TagPicker/index.d.ts

@@ -11,7 +11,8 @@ export interface TagPickerProps extends InputPickerProps, Partial<TagOnlyProps>
     renderMenuItemCheckbox?: (checkboxProps: CheckboxProps) => React.ReactNode;
 }
 /**
- * Multi-select by tag and support new options
+ * `TagPicker` component enables multi-selection by tags and supports new options.
+ *
  * @see https://rsuitejs.com/components/tag-picker/
  */
 declare const TagPicker: PickerComponent<TagPickerProps>;

package/cjs/TagPicker/index.js

@@ -11,7 +11,8 @@ var _react = _interopRequireWildcard(require("react"));
 var _InputPicker = _interopRequireDefault(require("../InputPicker/InputPicker"));
 var _InputPickerContext = _interopRequireDefault(require("../InputPicker/InputPickerContext"));
 /**
- * Multi-select by tag and support new options
+ * `TagPicker` component enables multi-selection by tags and supports new options.
+ *
  * @see https://rsuitejs.com/components/tag-picker/
  */
 var TagPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {

package/cjs/Timeline/Timeline.d.ts

@@ -21,5 +21,10 @@ interface TimelineComponent extends RsRefForwardingComponent<'div', TimelineProp
     ACTIVE_FIRST: (index: number, totalItemsCount: number) => boolean;
     ACTIVE_LAST: (index: number, totalItemsCount: number) => boolean;
 }
+/**
+ * The `Timeline` component is used to display a list of items in chronological order.
+ *
+ * @see https://rsuitejs.com/components/timeline
+ */
 declare const Timeline: TimelineComponent;
 export default Timeline;

package/cjs/Timeline/Timeline.js

@@ -11,6 +11,11 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _some = _interopRequireDefault(require("lodash/some"));
 var _TimelineItem = _interopRequireDefault(require("./TimelineItem"));
 var _utils = require("../utils");
+/**
+ * The `Timeline` component is used to display a list of items in chronological order.
+ *
+ * @see https://rsuitejs.com/components/timeline
+ */
 var Timeline = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var children = props.children,
     _props$as = props.as,

package/cjs/Timeline/TimelineItem.d.ts

@@ -29,5 +29,10 @@ export interface TimelineItemProps extends WithAsProps {
      */
     INTERNAL_active?: boolean;
 }
+/**
+ * The `Timeline.Item` component is used to set the layout of the child element in the `Timeline` component.
+ *
+ * @see https://rsuitejs.com/compo◊nents/timeline
+ */
 declare const TimelineItem: RsRefForwardingComponent<'div', TimelineItemProps>;
 export default TimelineItem;

package/cjs/Timeline/TimelineItem.js

@@ -9,6 +9,11 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
+/**
+ * The `Timeline.Item` component is used to set the layout of the child element in the `Timeline` component.
+ *
+ * @see https://rsuitejs.com/compo◊nents/timeline
+ */
 var TimelineItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'li' : _props$as,

package/cjs/Toggle/Toggle.d.ts

@@ -25,5 +25,10 @@ export interface ToggleProps extends WithAsProps {
     /** Callback function when state changes */
     onChange?: (checked: boolean, event: React.ChangeEvent<HTMLInputElement>) => void;
 }
+/**
+ * The `Toggle` component is used to activate or deactivate an element.
+ *
+ * @see https://rsuitejs.com/components/toggle
+ */
 declare const Toggle: RsRefForwardingComponent<'label', ToggleProps>;
 export default Toggle;