rsuite 5.47.0 → 5.48.0

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,

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

@@ -12,6 +12,11 @@ var STEP_STATUS_ICON = {
   process: null,
   error: /*#__PURE__*/React.createElement(Close, 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.forwardRef(function (props, ref) {
   var _withClassPrefix, _STEP_STATUS_ICON$sta;
   var _props$as = props.as,

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

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

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

@@ -2,7 +2,7 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import React from 'react';
-import { Table, Column, Cell, HeaderCell, ColumnGroup } from 'rsuite-table';
+import { Table as RsTable, Column, Cell, HeaderCell, ColumnGroup } from 'rsuite-table';
 import { useCustom } from '../utils';
 var CustomTable = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var localeProp = props.locale,
@@ -12,16 +12,35 @@ var CustomTable = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _useCustom = useCustom('Table', localeProp),
     locale = _useCustom.locale,
     rtl = _useCustom.rtl;
-  return /*#__PURE__*/React.createElement(Table, _extends({}, rest, {
+  return /*#__PURE__*/React.createElement(RsTable, _extends({}, rest, {
     rtl: rtl,
     ref: ref,
     locale: locale,
     loadAnimation: loadAnimation
   }));
 });
-export 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: Cell,
+  /**
+   * The `Table.Column` component  is used to define a column in a table.
+   */
   Column: Column,
+  /**
+   * The `Table.HeaderCell` component  is used to define a header cell in a table.
+   */
   HeaderCell: HeaderCell,
+  /**
+   * The `Table.ColumnGroup` component  is used to define a column group in a table.
+   */
   ColumnGroup: ColumnGroup
-});
+});
+export default Table;

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

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

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

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

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

@@ -4,6 +4,11 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React, { useMemo } from 'react';
 import InputPicker from '../InputPicker/InputPicker';
 import InputPickerContext from '../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.forwardRef(function (props, ref) {
   var _props$tagProps = props.tagProps,
     tagProps = _props$tagProps === void 0 ? {} : _props$tagProps,

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

@@ -5,7 +5,8 @@ import React, { useMemo } from 'react';
 import InputPicker from '../InputPicker/InputPicker';
 import InputPickerContext from '../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.forwardRef(function (props, ref) {

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

@@ -6,6 +6,11 @@ import PropTypes from 'prop-types';
 import some from 'lodash/some';
 import TimelineItem from './TimelineItem';
 import { useClassNames, ReactChildren } from '../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.forwardRef(function (props, ref) {
   var children = props.children,
     _props$as = props.as,

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

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

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

package/esm/Toggle/Toggle.js

@@ -6,6 +6,11 @@ import PropTypes from 'prop-types';
 import { partitionHTMLProps, useClassNames, useControlled, useCustom } from '../utils';
 import Plaintext from '../Plaintext';
 import Loader from '../Loader';
+/**
+ * The `Toggle` component is used to activate or deactivate an element.
+ *
+ * @see https://rsuitejs.com/components/toggle
+ */
 var Toggle = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,