rsuite 5.46.1 → 5.48.0

package/cjs/IconButton/IconButton.js

@@ -10,6 +10,10 @@ var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _Button = _interopRequireDefault(require("../Button"));
+/**
+ * The `IconButton` component is used to specify a button with icon.
+ * @see https://rsuitejs.com/components/button
+ */
 var IconButton = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var icon = props.icon,
     _props$placement = props.placement,

package/cjs/Input/Input.d.ts

@@ -17,5 +17,9 @@ export interface InputProps extends WithAsProps, Omit<React.InputHTMLAttributes<
     /** Called on press enter */
     onPressEnter?: React.KeyboardEventHandler<HTMLInputElement>;
 }
+/**
+ * The `<Input>` component is used to get user input in a text field.
+ * @see https://rsuitejs.com/components/input
+ */
 declare const Input: RsRefForwardingComponent<'input', InputProps>;
 export default Input;

package/cjs/Input/Input.js

@@ -13,6 +13,10 @@ var _FormGroup = require("../FormGroup/FormGroup");
 var _InputGroup = require("../InputGroup/InputGroup");
 var _Plaintext = _interopRequireDefault(require("../Plaintext"));
 var _utils = require("../utils");
+/**
+ * The `<Input>` component is used to get user input in a text field.
+ * @see https://rsuitejs.com/components/input
+ */
 var Input = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$classPrefix = props.classPrefix,

package/cjs/InputGroup/InputGroup.d.ts

@@ -20,5 +20,9 @@ export interface InputGroupComponent extends RsRefForwardingComponent<'div', Inp
     Addon: typeof InputGroupAddon;
     Button: typeof InputGroupButton;
 }
+/**
+ * The `InputGroup` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroup: InputGroupComponent;
 export default InputGroup;

package/cjs/InputGroup/InputGroup.js

@@ -14,6 +14,10 @@ var _InputGroupButton = _interopRequireDefault(require("./InputGroupButton"));
 var _utils = require("../utils");
 var InputGroupContext = /*#__PURE__*/_react.default.createContext(null);
 exports.InputGroupContext = InputGroupContext;
+/**
+ * The `InputGroup` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroup = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/InputGroup/InputGroupAddon.d.ts

@@ -4,5 +4,9 @@ export interface InputGroupAddonProps extends WithAsProps, React.HTMLAttributes<
     /** An Input group addon can show that it is disabled */
     disabled?: boolean;
 }
+/**
+ * The `InputGroup.Addon` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroupAddon: RsRefForwardingComponent<'span', InputGroupAddonProps>;
 export default InputGroupAddon;

package/cjs/InputGroup/InputGroupAddon.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 `InputGroup.Addon` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroupAddon = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'span' : _props$as,

package/cjs/InputGroup/InputGroupButton.d.ts

@@ -1,4 +1,8 @@
 import React from 'react';
 import { ButtonProps } from '../Button';
+/**
+ * The `InputGroup.Button` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 declare const InputGroupButton: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<any>>;
 export default InputGroupButton;

package/cjs/InputGroup/InputGroupButton.js

@@ -9,6 +9,10 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = _interopRequireDefault(require("react"));
 var _utils = require("../utils");
 var _Button = _interopRequireDefault(require("../Button"));
+/**
+ * The `InputGroup.Button` component is used to specify an input field with an add-on.
+ * @see https://rsuitejs.com/components/input/#input-group
+ */
 var InputGroupButton = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,
     classPrefix = _props$classPrefix === void 0 ? 'input-group-btn' : _props$classPrefix,

package/cjs/InputNumber/InputNumber.d.ts

@@ -21,5 +21,9 @@ export interface InputNumberProps<T = number | string> extends Omit<React.InputH
     scrollable?: boolean;
     onWheel?: (event: React.WheelEvent) => void;
 }
+/**
+ * The `InputNumber` component is used to enter a numerical value.
+ * @see https://rsuitejs.com/components/input-number
+ */
 declare const InputNumber: React.ForwardRefExoticComponent<InputNumberProps<string | number> & React.RefAttributes<unknown>>;
 export default InputNumber;

package/cjs/InputNumber/InputNumber.js

@@ -72,6 +72,11 @@ function valueReachesMin(value, min) {
   }
   return false;
 }
+
+/**
+ * The `InputNumber` component is used to enter a numerical value.
+ * @see https://rsuitejs.com/components/input-number
+ */
 var InputNumber = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? _InputGroup.default : _props$as,

package/cjs/InputPicker/InputPicker.d.ts

@@ -1,27 +1,8 @@
 import React from 'react';
-import { InputPickerLocale } from '../locales';
 import { PickerComponent, PickerToggleProps } from '../Picker';
-import { TagProps } from '../Tag';
-import { ItemDataType, FormControlPickerProps } from '../@types/common';
-import { SelectProps } from '../SelectPicker';
-export declare type TriggerType = 'Enter' | 'Space' | 'Comma';
-export interface InputPickerContextProps {
-    /** Multiple selections are allowed */
-    multi?: boolean;
-    /** Tag related props. */
-    tagProps: TagProps;
-    /**
-     * Set the trigger for creating tags. only valid when creatable
-     */
-    trigger: TriggerType | TriggerType[];
-    /**
-     * No overlay provides options
-     */
-    disabledOptions?: boolean;
-    /** Callback fired when a tag is removed. */
-    onTagRemove?: (tag: string, event: React.MouseEvent) => void;
-}
-export declare const InputPickerContext: React.Context<InputPickerContextProps>;
+import type { ItemDataType, FormControlPickerProps } from '../@types/common';
+import type { InputPickerLocale } from '../locales';
+import type { SelectProps } from '../SelectPicker';
 interface InputItemDataType extends ItemDataType {
     create?: boolean;
 }
@@ -48,5 +29,10 @@ export interface InputPickerProps<T = ValueType> extends FormControlPickerProps<
      */
     shouldDisplayCreateOption?: (searchKeyword: string, filteredData: InputItemDataType[]) => boolean;
 }
+/**
+ * Single item selector with text box input.
+ *
+ * @see https://rsuitejs.com/components/input-picker
+ */
 declare const InputPicker: PickerComponent<InputPickerProps>;
 export default InputPicker;

package/cjs/InputPicker/InputPicker.js

@@ -4,7 +4,7 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
 exports.__esModule = true;
-exports.default = exports.InputPickerContext = void 0;
+exports.default = void 0;
 var _taggedTemplateLiteralLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteralLoose"));
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
@@ -28,12 +28,13 @@ var _Picker = require("../Picker");
 var _Tag = _interopRequireDefault(require("../Tag"));
 var _InputAutosize = _interopRequireDefault(require("./InputAutosize"));
 var _InputSearch = _interopRequireDefault(require("./InputSearch"));
+var _InputPickerContext = _interopRequireDefault(require("./InputPickerContext"));
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
-var InputPickerContext = /*#__PURE__*/_react.default.createContext({
-  tagProps: {},
-  trigger: 'Enter'
-});
-exports.InputPickerContext = InputPickerContext;
+/**
+ * Single item selector with text box input.
+ *
+ * @see https://rsuitejs.com/components/input-picker
+ */
 var InputPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _merge;
   var _props$as = props.as,
@@ -104,12 +105,13 @@ var InputPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     _props$placement = props.placement,
     placement = _props$placement === void 0 ? 'bottomStart' : _props$placement,
     rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "appearance", "cleanable", "cacheData", "classPrefix", "data", "disabled", "readOnly", "plaintext", "defaultValue", "defaultOpen", "disabledItemValues", "locale", "toggleAs", "style", "searchable", "open", "placeholder", "groupBy", "menuClassName", "menuStyle", "menuAutoWidth", "menuMaxHeight", "creatable", "shouldDisplayCreateOption", "value", "valueKey", "virtualized", "labelKey", "listProps", "id", "tabIndex", "sort", "renderMenu", "renderExtraFooter", "renderValue", "renderMenuItem", "renderMenuGroup", "onEnter", "onEntered", "onExit", "onExited", "onChange", "onClean", "onCreate", "onSearch", "onSelect", "onOpen", "onClose", "onBlur", "onFocus", "searchBy", "placement"]);
-  var _useContext = (0, _react.useContext)(InputPickerContext),
+  var _useContext = (0, _react.useContext)(_InputPickerContext.default),
     multi = _useContext.multi,
     tagProps = _useContext.tagProps,
     trigger = _useContext.trigger,
     disabledOptions = _useContext.disabledOptions,
-    onTagRemove = _useContext.onTagRemove;
+    onTagRemove = _useContext.onTagRemove,
+    renderMenuItemCheckbox = _useContext.renderMenuItemCheckbox;
   if (groupBy === valueKey || groupBy === labelKey) {
     throw Error('`groupBy` can not be equal to `valueKey` and `labelKey`');
   }
@@ -564,6 +566,9 @@ var InputPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       classPrefix: menuClassPrefix,
       dropdownMenuItemClassPrefix: multi ? undefined : menuClassPrefix + "-item",
       dropdownMenuItemAs: multi ? _Picker.DropdownMenuCheckItem : _Picker.DropdownMenuItem,
+      dropdownMenuItemProps: {
+        renderMenuItemCheckbox: renderMenuItemCheckbox
+      },
       activeItemValues: multi ? value : [value],
       focusItemValue: focusItemValue,
       maxHeight: menuMaxHeight,

package/cjs/InputPicker/InputPickerContext.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import type { TagProps } from '../Tag';
+import type { CheckboxProps } from '../Checkbox';
+export declare type TriggerType = 'Enter' | 'Space' | 'Comma';
+export interface TagOnlyProps {
+    /**  Tag related props. */
+    tagProps: TagProps;
+    /**
+     * 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;
+}
+export interface InputPickerContextProps extends TagOnlyProps {
+    /** Multiple selections are allowed */
+    multi?: boolean;
+    /**
+     * No overlay provides options
+     */
+    disabledOptions?: boolean;
+    /** Custom render checkbox on menu item */
+    renderMenuItemCheckbox?: (checkboxProps: CheckboxProps) => React.ReactNode;
+}
+declare const InputPickerContext: React.Context<InputPickerContextProps>;
+export default InputPickerContext;

package/cjs/InputPicker/InputPickerContext.js

@@ -0,0 +1,13 @@
+'use client';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var InputPickerContext = /*#__PURE__*/_react.default.createContext({
+  tagProps: {},
+  trigger: 'Enter'
+});
+var _default = InputPickerContext;
+exports.default = _default;

package/cjs/List/List.d.ts

@@ -10,5 +10,9 @@ export interface ListProps extends WithAsProps, SortConfig {
 export interface ListComponent extends RsRefForwardingComponent<'div', ListProps> {
     Item: typeof ListItem;
 }
+/**
+ * The `List` component is used to specify the layout of the list.
+ * @see https://rsuitejs.com/components/list
+ */
 declare const List: ListComponent;
 export default List;

package/cjs/List/List.js

@@ -13,6 +13,10 @@ var _useSortHelper2 = _interopRequireDefault(require("./helper/useSortHelper"));
 var _utils = require("../utils");
 var _ListContext = _interopRequireDefault(require("./ListContext"));
 var _ListItem = _interopRequireDefault(require("./ListItem"));
+/**
+ * The `List` component is used to specify the layout of the list.
+ * @see https://rsuitejs.com/components/list
+ */
 var List = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/List/ListItem.d.ts

@@ -7,5 +7,9 @@ export interface ListItemProps extends WithAsProps, React.HTMLAttributes<HTMLEle
     disabled?: boolean;
     size?: 'lg' | 'md' | 'sm';
 }
+/**
+ * The `List.Item` component is used to specify the layout of the list item.
+ * @see https://rsuitejs.com/components/list
+ */
 declare const ListItem: React.ForwardRefExoticComponent<ListItemProps & React.RefAttributes<HTMLDivElement>>;
 export default ListItem;

package/cjs/List/ListItem.js

@@ -11,6 +11,10 @@ var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _utils = require("../utils");
 var _ListContext = _interopRequireDefault(require("./ListContext"));
+/**
+ * The `List.Item` component is used to specify the layout of the list item.
+ * @see https://rsuitejs.com/components/list
+ */
 var ListItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Loader/Loader.d.ts

@@ -16,5 +16,9 @@ export interface LoaderProps extends WithAsProps {
     /** A loader can have different sizes */
     size?: TypeAttributes.Size;
 }
+/**
+ * The `Loader` component is used to indicate the loading state of a page or a section.
+ * @see https://rsuitejs.com/components/loader
+ */
 declare const Loader: RsRefForwardingComponent<'div', LoaderProps>;
 export default Loader;

package/cjs/Loader/Loader.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 `Loader` component is used to indicate the loading state of a page or a section.
+ * @see https://rsuitejs.com/components/loader
+ */
 var Loader = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/MaskedInput/TextMask.d.ts

@@ -32,6 +32,10 @@ export declare type TextMaskProps = TextMaskBaseProps & React.HTMLAttributes<HTM
     readOnly?: boolean;
     disabled?: boolean;
 };
+/**
+ * The `TextMask` component is used to format the user input data.
+ * @see https://rsuitejs.com/components/input/#masked-input
+ */
 declare const TextMask: React.ForwardRefExoticComponent<TextMaskBaseProps & React.HTMLAttributes<HTMLInputElement> & {
     /** Custom rendering DOM */
     render?: ((ref: React.Ref<HTMLInputElement>, props: React.HTMLAttributes<HTMLInputElement>) => any) | undefined;

package/cjs/MaskedInput/TextMask.js

@@ -21,6 +21,11 @@ var defaultRender = function defaultRender(ref, props) {
     ref: ref
   }, props));
 };
+
+/**
+ * The `TextMask` component is used to format the user input data.
+ * @see https://rsuitejs.com/components/input/#masked-input
+ */
 var TextMask = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var mask = props.mask,
     _props$guide = props.guide,

package/cjs/MaskedInput/createTextMaskInputElement.js

@@ -10,11 +10,9 @@ var _isNumber = _interopRequireDefault(require("lodash/isNumber"));
 var _adjustCaretPosition = _interopRequireDefault(require("./adjustCaretPosition"));
 var _conformToMask2 = _interopRequireDefault(require("./conformToMask"));
 var _utilities = require("./utilities");
+var _safeSetSelection = _interopRequireDefault(require("../utils/safeSetSelection"));
 var emptyString = '';
-var strNone = 'none';
 var strObject = 'object';
-var isAndroid = typeof navigator !== 'undefined' && /Android/i.test(navigator.userAgent);
-var defer = typeof requestAnimationFrame !== 'undefined' ? requestAnimationFrame : setTimeout;
 function createTextMaskInputElement(config) {
   // Anything that we will need to keep between `update` calls, we will store in this `state` object.
   var state = {
@@ -146,7 +144,7 @@ function createTextMaskInputElement(config) {
         // indicate rejection. Or return just a string when there are no piped characters.
         // If the `pipe` returns `false` or a string, the block below turns it into an object that the rest
         // of the code can work with.
-        if (pipeResults === false) {
+        if (typeof pipeResults === 'boolean' && pipeResults === false) {
           // If the `pipe` rejects `conformedValue`, we use the `previousConformedValue`, and set `rejected` to `true`.
           pipeResults = {
             value: previousConformedValue,
@@ -191,22 +189,14 @@ function createTextMaskInputElement(config) {
         return;
       }
       inputElement.value = inputElementValue; // set the input value
-      safeSetSelection(inputElement, adjustedCaretPosition); // adjust caret position
+
+      if (typeof adjustedCaretPosition === 'number') {
+        (0, _safeSetSelection.default)(inputElement, adjustedCaretPosition, adjustedCaretPosition); // adjust caret position
+      }
     }
   };
 }
 
-function safeSetSelection(element, selectionPosition) {
-  if (document.activeElement === element) {
-    if (isAndroid) {
-      defer(function () {
-        return element.setSelectionRange(selectionPosition, selectionPosition, strNone);
-      }, 0);
-    } else {
-      element.setSelectionRange(selectionPosition, selectionPosition, strNone);
-    }
-  }
-}
 function getSafeRawValue(inputValue) {
   if ((0, _isString.default)(inputValue)) {
     return inputValue;

package/cjs/Message/Message.d.ts

@@ -24,5 +24,9 @@ export interface MessageProps extends WithAsProps {
     /** Callback after the message is removed */
     onClose?: (event?: React.MouseEvent<HTMLButtonElement>) => void;
 }
+/**
+ * The `Message` component is used to display important messages to users.
+ * @see https://rsuitejs.com/components/message
+ */
 declare const Message: RsRefForwardingComponent<'div', MessageProps>;
 export default Message;

package/cjs/Message/Message.js

@@ -14,6 +14,10 @@ var _utils = require("../utils");
 var _CloseButton = _interopRequireDefault(require("../CloseButton"));
 var _ToastContext = _interopRequireDefault(require("../toaster/ToastContext"));
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+/**
+ * The `Message` component is used to display important messages to users.
+ * @see https://rsuitejs.com/components/message
+ */
 var Message = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _withClassPrefix;
   var _props$as = props.as,

package/cjs/Modal/Modal.d.ts

@@ -35,5 +35,9 @@ interface ModalComponent extends RsRefForwardingComponent<'div', ModalProps> {
     Footer: typeof ModalFooter;
     Dialog: typeof ModalDialog;
 }
+/**
+ * The `Modal` component is used to show content in a layer above the app.
+ * @see https://rsuitejs.com/components/modal
+ */
 declare const Modal: ModalComponent;
 export default Modal;

package/cjs/Modal/Modal.js

@@ -28,6 +28,10 @@ var _deprecatePropType = _interopRequireDefault(require("../utils/deprecatePropT
 var _DrawerContext = _interopRequireDefault(require("../Drawer/DrawerContext"));
 var _templateObject, _templateObject2;
 var modalSizes = ['xs', 'sm', 'md', 'lg', 'full'];
+/**
+ * The `Modal` component is used to show content in a layer above the app.
+ * @see https://rsuitejs.com/components/modal
+ */
 var Modal = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _prefix;
   var className = props.className,

package/cjs/MultiCascader/MultiCascader.d.ts

@@ -34,5 +34,9 @@ export interface MultiCascaderProps<T = ValueType> extends FormControlPickerProp
     /** Asynchronously load the children of the tree node. */
     getChildren?: (node: ItemDataType) => ItemDataType[] | Promise<ItemDataType[]>;
 }
+/**
+ * The `MultiCascader` component is used to select multiple values from cascading options.
+ * @see https://rsuitejs.com/components/multi-cascader/
+ */
 declare const MultiCascader: PickerComponent<MultiCascaderProps>;
 export default MultiCascader;

package/cjs/MultiCascader/MultiCascader.js

@@ -21,6 +21,11 @@ var _utils2 = require("../Cascader/utils");
 var _utils3 = require("../utils");
 var _Picker = require("../Picker");
 var emptyArray = [];
+
+/**
+ * The `MultiCascader` component is used to select multiple values from cascading options.
+ * @see https://rsuitejs.com/components/multi-cascader/
+ */
 var MultiCascader = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _selectedPaths;
   var _props$as = props.as,

package/cjs/Nav/Nav.d.ts

@@ -27,5 +27,9 @@ interface NavComponent extends RsRefForwardingComponent<'div', NavProps> {
     Item: typeof NavItem;
     Menu: typeof NavMenu;
 }
+/**
+ * The `Nav` component is used to create navigation links.
+ * @see https://rsuitejs.com/components/nav
+ */
 declare const Nav: NavComponent;
 export default Nav;

package/cjs/Nav/Nav.js

@@ -26,6 +26,10 @@ var _SidenavDropdownItem = _interopRequireDefault(require("../Sidenav/SidenavDro
 var _NavbarItem = _interopRequireDefault(require("../Navbar/NavbarItem"));
 var _SidenavItem = _interopRequireDefault(require("../Sidenav/SidenavItem"));
 var _useInternalId = _interopRequireDefault(require("../utils/useInternalId"));
+/**
+ * The `Nav` component is used to create navigation links.
+ * @see https://rsuitejs.com/components/nav
+ */
 var Nav = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Nav/NavDropdown.d.ts

@@ -60,8 +60,9 @@ export interface NavDropdownComponent extends RsRefForwardingComponent<'div', Na
 }
 /**
  * @private this component is not supposed to be used directly
- *          Instead it's rendered by a <Nav.Menu> call
+ *          Instead it's rendered by a `<Nav.Menu>` call
  *
+ * @example
  * <Nav>
  *   <Nav.Menu> -> This will render <NavDropdown> component
  *   </Nav.Menu>

package/cjs/Nav/NavDropdown.js

@@ -22,8 +22,9 @@ var _NavDropdownMenu = _interopRequireDefault(require("./NavDropdownMenu"));
 var _NavDropdownToggle = _interopRequireDefault(require("./NavDropdownToggle"));
 /**
  * @private this component is not supposed to be used directly
- *          Instead it's rendered by a <Nav.Menu> call
+ *          Instead it's rendered by a `<Nav.Menu>` call
  *
+ * @example
  * <Nav>
  *   <Nav.Menu> -> This will render <NavDropdown> component
  *   </Nav.Menu>

package/cjs/Nav/NavItem.d.ts

@@ -20,9 +20,12 @@ export interface NavItemProps<T = string> extends WithAsProps, Omit<React.HTMLAt
     onSelect?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
 }
 /**
- * The <Nav.Item> API
- * When used as direct child of <Nav>, render the NavItem
- * When used within a <Nav.Menu>, render the NavDropdownItem
+ * The `Nav.Item` component is used to create navigation links.
+ *
+ * - When used as direct child of `<Nav>`, render the NavItem
+ * - When used within a `<Nav.Menu>`, render the NavDropdownItem
+ * @see https://rsuitejs.com/components/nav
+ *
  */
 declare const NavItem: RsRefForwardingComponent<'a', NavItemProps>;
 export default NavItem;

package/cjs/Nav/NavItem.js

@@ -15,9 +15,12 @@ var _SafeAnchor = _interopRequireDefault(require("../SafeAnchor"));
 var _utils = require("../utils");
 var _NavContext = _interopRequireDefault(require("./NavContext"));
 /**
- * The <Nav.Item> API
- * When used as direct child of <Nav>, render the NavItem
- * When used within a <Nav.Menu>, render the NavDropdownItem
+ * The `Nav.Item` component is used to create navigation links.
+ *
+ * - When used as direct child of `<Nav>`, render the NavItem
+ * - When used within a `<Nav.Menu>`, render the NavDropdownItem
+ * @see https://rsuitejs.com/components/nav
+ *
  */
 var NavItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var nav = (0, _react.useContext)(_NavContext.default);

package/cjs/Nav/NavMenu.d.ts

@@ -30,9 +30,12 @@ export declare type NavMenuAction = {
     };
 };
 /**
- * The <Nav.Menu> API
- * When used as direct child of <Nav>, render the NavDropdown
- * When used within another <Nav.Menu>, render the NavDropdownMenu
+ * The `Nav.Menu` component is used to create navigation menus.
+ *
+ * - When used as direct child of `<Nav>`, render the NavDropdown
+ * - When used within another `<Nav.Menu>`, render the NavDropdownMenu
+ *
+ * @see https://rsuitejs.com/components/nav
  */
 declare const NavMenu: React.ForwardRefExoticComponent<NavMenuProps & React.RefAttributes<any>>;
 export default NavMenu;

package/cjs/Nav/NavMenu.js

@@ -47,9 +47,12 @@ var reducer = function reducer(state, action) {
 };
 
 /**
- * The <Nav.Menu> API
- * When used as direct child of <Nav>, render the NavDropdown
- * When used within another <Nav.Menu>, render the NavDropdownMenu
+ * The `Nav.Menu` component is used to create navigation menus.
+ *
+ * - When used as direct child of `<Nav>`, render the NavDropdown
+ * - When used within another `<Nav.Menu>`, render the NavDropdownMenu
+ *
+ * @see https://rsuitejs.com/components/nav
  */
 var NavMenu = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var parentNavMenu = (0, _react.useContext)(NavMenuContext);

package/cjs/Navbar/Navbar.d.ts

@@ -20,5 +20,9 @@ interface NavbarComponent extends RsRefForwardingComponent<'div', NavbarProps> {
     Body: typeof NavbarBody;
     Brand: typeof NavbarBrand;
 }
+/**
+ * The `Navbar` component is used to create a navigation header.
+ * @see https://rsuitejs.com/components/navbar
+ */
 declare const Navbar: NavbarComponent;
 export default Navbar;

package/cjs/Navbar/Navbar.js

@@ -13,6 +13,10 @@ var _NavbarBrand = _interopRequireDefault(require("./NavbarBrand"));
 var _utils = require("../utils");
 var NavbarContext = /*#__PURE__*/_react.default.createContext(false);
 exports.NavbarContext = NavbarContext;
+/**
+ * The `Navbar` component is used to create a navigation header.
+ * @see https://rsuitejs.com/components/navbar
+ */
 var Navbar = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$as = props.as,

package/cjs/Notification/Notification.d.ts

@@ -22,5 +22,10 @@ export interface NotificationProps extends WithAsProps {
     /** Callback after the message is removed */
     onClose?: (event?: React.MouseEvent<HTMLButtonElement>) => void;
 }
+/**
+ * The `Notification` component is used to display global messages and notifications.
+ *
+ * @see https://rsuitejs.com/components/notification
+ */
 declare const Notification: RsRefForwardingComponent<'div', NotificationProps>;
 export default Notification;