rsuite 5.46.1 → 5.48.0

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

@@ -5,8 +5,14 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 var _templateObject, _templateObject2;
 import React from 'react';
 import PropTypes from 'prop-types';
-import { useClassNames } from '../utils';
+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,
@@ -28,6 +34,8 @@ var Tag = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var classes = merge(className, withClassPrefix(size, color, {
     closable: closable
   }));
+  var _useCustom = useCustom(),
+    locale = _useCustom.locale;
   return /*#__PURE__*/React.createElement(Component, _extends({}, rest, {
     ref: ref,
     className: classes
@@ -35,7 +43,11 @@ var Tag = /*#__PURE__*/React.forwardRef(function (props, ref) {
     className: prefix(_templateObject || (_templateObject = _taggedTemplateLiteralLoose(["text"])))
   }, children), closable && /*#__PURE__*/React.createElement(CloseButton, {
     className: prefix(_templateObject2 || (_templateObject2 = _taggedTemplateLiteralLoose(["icon-close"]))),
-    onClick: onClose
+    onClick: onClose,
+    tabIndex: -1,
+    locale: {
+      closeLabel: locale === null || locale === void 0 ? void 0 : locale.remove
+    }
   }));
 });
 Tag.displayName = 'Tag';

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

@@ -1,18 +1,11 @@
-import React from 'react';
-import { InputPickerProps, TriggerType } from '../InputPicker/InputPicker';
+import { InputPickerProps } from '../InputPicker/InputPicker';
+import { TagOnlyProps } from '../InputPicker/InputPickerContext';
 import type { PickerComponent } from '../Picker/types';
-import type { TagProps } from '../Tag';
-export interface TagInputProps extends Omit<InputPickerProps<readonly string[]>, 'data'> {
-    /**  Tag related props. */
-    tagProps?: TagProps;
-    /**
-     * Set the trigger for creating tags. only valid when creatable
-     *
-     * @todo Declare as readonly array
-     */
-    trigger?: TriggerType | TriggerType[];
-    /** Callback fired when a tag is removed. */
-    onTagRemove?: (tag: string, event: React.MouseEvent) => void;
-}
+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

@@ -2,7 +2,13 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import React, { useMemo } from 'react';
-import InputPicker, { InputPickerContext } from '../InputPicker/InputPicker';
+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

@@ -1,16 +1,19 @@
 import React from 'react';
-import { InputPickerProps, TriggerType } from '../InputPicker/InputPicker';
+import { InputPickerProps } from '../InputPicker/InputPicker';
+import { TagOnlyProps } from '../InputPicker/InputPickerContext';
 import type { PickerComponent } from '../Picker/types';
-import type { TagProps } from '../Tag';
-export interface TagPickerProps extends InputPickerProps {
-    /**  Tag related props. */
-    tagProps?: TagProps;
+import type { CheckboxProps } from '../Checkbox';
+export interface TagPickerProps extends InputPickerProps, Partial<TagOnlyProps> {
     /**
-     * Set the trigger for creating tags. only valid when creatable
-     */
-    trigger?: TriggerType | TriggerType[];
-    /** Callback fired when a tag is removed. */
-    onTagRemove?: (tag: string, event: React.MouseEvent) => void;
+     * Custom render checkbox on menu item
+     * @version 5.47.0
+     **/
+    renderMenuItemCheckbox?: (checkboxProps: CheckboxProps) => React.ReactNode;
 }
+/**
+ * `TagPicker` component enables multi-selection by tags and supports new options.
+ *
+ * @see https://rsuitejs.com/components/tag-picker/
+ */
 declare const TagPicker: PickerComponent<TagPickerProps>;
 export default TagPicker;

package/esm/TagPicker/index.js

@@ -2,22 +2,30 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import React, { useMemo } from 'react';
-import InputPicker, { InputPickerContext } from '../InputPicker/InputPicker';
+import InputPicker from '../InputPicker/InputPicker';
+import InputPickerContext from '../InputPicker/InputPickerContext';
+/**
+ * `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) {
   var _props$tagProps = props.tagProps,
     tagProps = _props$tagProps === void 0 ? {} : _props$tagProps,
     _props$trigger = props.trigger,
     trigger = _props$trigger === void 0 ? 'Enter' : _props$trigger,
     onTagRemove = props.onTagRemove,
-    rest = _objectWithoutPropertiesLoose(props, ["tagProps", "trigger", "onTagRemove"]);
+    renderMenuItemCheckbox = props.renderMenuItemCheckbox,
+    rest = _objectWithoutPropertiesLoose(props, ["tagProps", "trigger", "onTagRemove", "renderMenuItemCheckbox"]);
   var contextValue = useMemo(function () {
     return {
       multi: true,
       trigger: trigger,
       tagProps: tagProps,
-      onTagRemove: onTagRemove
+      onTagRemove: onTagRemove,
+      renderMenuItemCheckbox: renderMenuItemCheckbox
     };
-  }, [onTagRemove, tagProps, trigger]);
+  }, [onTagRemove, renderMenuItemCheckbox, tagProps, trigger]);
   return /*#__PURE__*/React.createElement(InputPickerContext.Provider, {
     value: contextValue
   }, /*#__PURE__*/React.createElement(InputPicker, _extends({}, rest, {

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,

package/esm/Tooltip/Tooltip.d.ts

@@ -10,5 +10,10 @@ export interface TooltipProps extends WithAsProps {
     /** Whether show the arrow indicator */
     arrow?: boolean;
 }
+/**
+ * The `Tooltip` component is used to describe a element.
+ *
+ * @see https://rsuitejs.com/components/tooltip
+ */
 declare const Tooltip: RsRefForwardingComponent<'div', TooltipProps>;
 export default Tooltip;

package/esm/Tooltip/Tooltip.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 `Tooltip` component is used to describe a element.
+ *
+ * @see https://rsuitejs.com/components/tooltip
+ */
 var Tooltip = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Tree/Tree.d.ts

@@ -93,5 +93,10 @@ export interface TreeProps<ValueType = string | number> extends TreeBaseProps<Va
     /** Default selected Value  */
     defaultValue?: ValueType;
 }
+/**
+ * The `Tree` component is used to display hierarchical data.
+ *
+ * @see https://rsuitejs.com/components/tree
+ */
 declare const Tree: RsRefForwardingComponent<'div', TreeProps>;
 export default Tree;

package/esm/Tree/Tree.js

@@ -12,6 +12,11 @@ export var TREE_NODE_DROP_POSITION;
   TREE_NODE_DROP_POSITION[TREE_NODE_DROP_POSITION["DRAG_OVER_TOP"] = 1] = "DRAG_OVER_TOP";
   TREE_NODE_DROP_POSITION[TREE_NODE_DROP_POSITION["DRAG_OVER_BOTTOM"] = 2] = "DRAG_OVER_BOTTOM";
 })(TREE_NODE_DROP_POSITION || (TREE_NODE_DROP_POSITION = {}));
+/**
+ * The `Tree` component is used to display hierarchical data.
+ *
+ * @see https://rsuitejs.com/components/tree
+ */
 var Tree = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var contextValue = useMemo(function () {
     return {

package/esm/TreePicker/TreePicker.d.ts

@@ -23,5 +23,10 @@ export interface TreePickerProps<T = number | string> extends TreeBaseProps<T, I
     /** Called when scrolling */
     onScroll?: (event: React.SyntheticEvent) => void;
 }
+/**
+ * The `TreePicker` component is used for selecting single options which are organized in a tree structure.
+ *
+ * @see https://rsuitejs.com/components/tree-picker/
+ */
 declare const TreePicker: PickerComponent<TreePickerProps>;
 export default TreePicker;

package/esm/TreePicker/TreePicker.js

@@ -19,6 +19,12 @@ var emptyArray = [];
 var itemSize = function itemSize() {
   return 36;
 };
+
+/**
+ * The `TreePicker` component is used for selecting single options which are organized in a tree structure.
+ *
+ * @see https://rsuitejs.com/components/tree-picker/
+ */
 var TreePicker = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Uploader/UploadFileItem.js

@@ -132,7 +132,8 @@ var UploadFileItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
       role: "presentation",
       src: previewImage,
       alt: file.name,
-      onClick: handlePreview
+      onClick: handlePreview,
+      "aria-label": "Preview: " + file.name
     }) : /*#__PURE__*/React.createElement(Attachment, {
       className: prefix('icon')
     });
@@ -153,7 +154,8 @@ var UploadFileItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
       return /*#__PURE__*/React.createElement("div", {
         className: classes
       }, /*#__PURE__*/React.createElement("i", {
-        className: prefix('icon')
+        className: prefix('icon'),
+        "aria-label": "Uploading"
       }));
     }
     if (listType === 'picture' || listType === 'picture-text') {
@@ -173,9 +175,18 @@ var UploadFileItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
     if (!removable) {
       return null;
     }
+    var closeLabel = 'Remove file';
+    if (locale !== null && locale !== void 0 && locale.removeFile) {
+      closeLabel = (locale === null || locale === void 0 ? void 0 : locale.removeFile) + (file !== null && file !== void 0 && file.name ? ": " + (file === null || file === void 0 ? void 0 : file.name) : '');
+    }
     return /*#__PURE__*/React.createElement(CloseButton, {
       className: prefix('btn-remove'),
-      onClick: handleRemove
+      onClick: handleRemove,
+      tabIndex: -1,
+      locale: {
+        closeLabel: closeLabel
+      },
+      "aria-hidden": disabled
     });
   };
 
@@ -189,7 +200,8 @@ var UploadFileItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
       }, /*#__PURE__*/React.createElement("span", null, locale === null || locale === void 0 ? void 0 : locale.error), allowReupload && /*#__PURE__*/React.createElement("a", {
         role: "button",
         tabIndex: -1,
-        onClick: handleReupload
+        onClick: handleReupload,
+        "aria-label": "Retry"
       }, /*#__PURE__*/React.createElement(Reload, {
         className: prefix('icon-reupload')
       })));
@@ -216,7 +228,9 @@ var UploadFileItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var renderFilePanel = function renderFilePanel() {
     var fileElement = /*#__PURE__*/React.createElement("div", {
       className: prefix('title'),
-      onClick: handlePreview
+      tabIndex: -1,
+      onClick: handlePreview,
+      "aria-label": "Preview: " + file.name
     }, file.name);
     return /*#__PURE__*/React.createElement("div", {
       className: prefix('panel')

package/esm/Uploader/Uploader.d.ts

@@ -105,5 +105,10 @@ export interface FileProgressType {
     status?: FileStatusType;
     progress?: number;
 }
+/**
+ * The `Uploader` component is used to upload files.
+ *
+ * @see https://rsuitejs.com/components/uploader
+ */
 declare const Uploader: React.ForwardRefExoticComponent<UploaderProps & React.RefAttributes<unknown>>;
 export default Uploader;

package/esm/Uploader/Uploader.js

@@ -83,6 +83,12 @@ var useFileList = function useFileList(defaultFileList) {
   }, []);
   return [fileListRef, dispatchCallback];
 };
+
+/**
+ * The `Uploader` component is used to upload files.
+ *
+ * @see https://rsuitejs.com/components/uploader
+ */
 var Uploader = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/esm/Whisper/Whisper.d.ts

@@ -3,5 +3,11 @@ import { OverlayTriggerHandle } from '../Overlay/OverlayTrigger';
 import { OverlayTriggerProps } from '../Overlay/OverlayTrigger';
 export declare type WhisperProps = OverlayTriggerProps;
 export declare type WhisperInstance = OverlayTriggerHandle;
+/**
+ * The `Whisper` component is used to display a floating element.
+ * It is usually used with the `Tooltip` and `Popover` components.
+ *
+ * @see https://rsuitejs.com/components/whisper
+ */
 declare const Whisper: React.ForwardRefExoticComponent<OverlayTriggerProps & React.RefAttributes<OverlayTriggerHandle>>;
 export default Whisper;

package/esm/Whisper/Whisper.js

@@ -6,6 +6,12 @@ import PropTypes from 'prop-types';
 import OverlayTrigger from '../Overlay/OverlayTrigger';
 import { createChainedFunction, placementPolyfill, PLACEMENT } from '../utils';
 import { CustomContext } from '../CustomProvider';
+/**
+ * The `Whisper` component is used to display a floating element.
+ * It is usually used with the `Tooltip` and `Popover` components.
+ *
+ * @see https://rsuitejs.com/components/whisper
+ */
 var Whisper = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var onOpen = props.onOpen,
     onClose = props.onClose,

package/esm/Windowing/AutoSizer.d.ts

@@ -21,5 +21,10 @@ export interface AutoSizerProps {
     /** Callback to be invoked on-resize */
     onResize?: ((size: Size) => void) | undefined;
 }
+/**
+ * High-order component that automatically adjusts the width and height of a single child.
+ *
+ * @private
+ */
 declare const AutoSizer: React.ForwardRefExoticComponent<AutoSizerProps & React.RefAttributes<HTMLDivElement>>;
 export default AutoSizer;

package/esm/Windowing/AutoSizer.js

@@ -5,6 +5,11 @@ import React, { useState, useRef } from 'react';
 import { useCallback } from 'react';
 import getStyle from 'dom-lib/getStyle';
 import { mergeRefs, useElementResize, useMount } from '../utils';
+/**
+ * High-order component that automatically adjusts the width and height of a single child.
+ *
+ * @private
+ */
 var AutoSizer = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var children = props.children,
     className = props.className,

package/esm/Windowing/List.d.ts

@@ -5,7 +5,7 @@ export interface ListProps<T = any> extends WithAsProps {
      * @deprecated use itemSize instead
      * Either a fixed row height (number) or a function that returns the height of a row given its index: ({ index: number }): number
      */
-    rowHeight?: number | (({ index: number }: {
+    rowHeight?: number | (({ index }: {
         index: any;
     }) => number);
     /**
@@ -41,5 +41,10 @@ export interface ListHandle extends Partial<VariableSizeList> {
      */
     scrollToRow?: (index: number) => void;
 }
+/**
+ * This component renders a virtualized list of elements with either fixed or dynamic heights.
+ *
+ * @private
+ */
 declare const List: RsRefForwardingComponent<'div', ListProps>;
 export default List;

package/esm/Windowing/List.js

@@ -4,6 +4,11 @@ import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWith
 import React, { useRef, useImperativeHandle, useCallback, useMemo } from 'react';
 import { VariableSizeList } from 'react-window';
 import { useCustom } from '../utils';
+/**
+ * This component renders a virtualized list of elements with either fixed or dynamic heights.
+ *
+ * @private
+ */
 var List = /*#__PURE__*/React.forwardRef(function (props, ref) {
   var rowHeight = props.rowHeight,
     _props$as = props.as,