rsuite 5.47.0 → 5.48.1

package/cjs/DateInput/useDateInputState.d.ts

@@ -0,0 +1,165 @@
+import type { Locale } from 'date-fns';
+interface DateInputState {
+    formatStr: string;
+    localize: Locale['localize'];
+    date?: Date | null;
+    isControlledDate?: boolean;
+}
+declare function useDateInputState({ formatStr, localize, date, isControlledDate }: DateInputState): {
+    dateField: {
+        year: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: "AM" | "PM" | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        month: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: "AM" | "PM" | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        day: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: "AM" | "PM" | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        hour: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        minute: number | null;
+        second: number | null;
+        meridian: "AM" | "PM" | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        minute: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        second: number | null;
+        meridian: "AM" | "PM" | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        second: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        meridian: "AM" | "PM" | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    } | {
+        meridian: any;
+        format: string;
+        patternArray: {
+            pattern: string;
+            key: string;
+        }[];
+        year: number | null;
+        month: number | null;
+        day: number | null;
+        hour: number | null;
+        minute: number | null;
+        second: number | null;
+        constructor: Function;
+        toString(): string;
+        toLocaleString(): string;
+        valueOf(): Object;
+        hasOwnProperty(v: PropertyKey): boolean;
+        isPrototypeOf(v: Object): boolean;
+        propertyIsEnumerable(v: PropertyKey): boolean;
+        should: Chai.Assertion;
+    };
+    setDateOffset: (pattern: string, offset: number, callback?: ((newDate: Date) => void) | undefined) => void;
+    setDateField: (pattern: string, value: number | null, callback?: ((newDate: Date) => void) | undefined) => void;
+    getDateField: (pattern: string) => {
+        name: any;
+        value: any;
+    };
+    toDateString: () => string;
+};
+export default useDateInputState;

package/cjs/DateInput/useDateInputState.js

@@ -0,0 +1,105 @@
+'use client';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _react = require("react");
+var _startCase = _interopRequireDefault(require("lodash/startCase"));
+var _dateUtils = require("../utils/dateUtils");
+var _DateField = require("./DateField");
+function useDateInputState(_ref) {
+  var formatStr = _ref.formatStr,
+    localize = _ref.localize,
+    date = _ref.date,
+    isControlledDate = _ref.isControlledDate;
+  var _useDateField = (0, _DateField.useDateField)(formatStr, localize, date),
+    dateField = _useDateField.dateField,
+    dispatch = _useDateField.dispatch,
+    toDateString = _useDateField.toDateString,
+    toDate = _useDateField.toDate;
+  var setDateOffset = (0, _react.useCallback)(function (pattern, offset, callback) {
+    var currentDate = new Date();
+    var year = dateField.year || currentDate.getFullYear();
+    var month = dateField.month ? dateField.month - 1 : currentDate.getMonth();
+    var day = dateField.day || 0;
+    var hour = dateField.hour || 0;
+    var minute = dateField.minute || 0;
+    var second = dateField.second || 0;
+    var actionName;
+    var value;
+    switch (pattern) {
+      case 'y':
+        actionName = 'setYear';
+        value = (0, _dateUtils.addYears)(new Date(year, 0), offset).getFullYear();
+        break;
+      case 'M':
+        actionName = 'setMonth';
+        value = (0, _dateUtils.addMonths)(new Date(year, month), offset).getMonth() + 1;
+        break;
+      case 'd':
+        actionName = 'setDay';
+        var prevDate = new Date(year, month, day);
+        value = (0, _dateUtils.addDays)(prevDate, offset).getDate();
+        if (offset > 0) {
+          value = (0, _dateUtils.isLastDayOfMonth)(prevDate) ? 1 : value;
+        } else {
+          value = prevDate.getDate() === 1 ? (0, _dateUtils.lastDayOfMonth)(prevDate).getDate() : value;
+        }
+        break;
+      case 'H':
+      case 'h':
+        actionName = 'setHour';
+        value = (0, _dateUtils.addHours)(new Date(year, month, day, hour), offset).getHours();
+        break;
+      case 'm':
+        actionName = 'setMinute';
+        value = (0, _dateUtils.addMinutes)(new Date(year, month, day, hour, minute), offset).getMinutes();
+        break;
+      case 's':
+        actionName = 'setSecond';
+        value = (0, _dateUtils.addSeconds)(new Date(year, month, day, hour, minute, second), offset).getSeconds();
+        break;
+      case 'a':
+        actionName = 'setMeridian';
+        value = dateField.meridian === 'AM' ? 'PM' : 'AM';
+        break;
+    }
+    if (actionName && value) {
+      dispatch({
+        type: actionName,
+        value: value
+      });
+      var field = _DateField.patternMap[pattern];
+      callback === null || callback === void 0 ? void 0 : callback(toDate(field, value));
+    }
+  }, [dateField, toDate, dispatch]);
+  var setDateField = (0, _react.useCallback)(function (pattern, value, callback) {
+    var field = _DateField.patternMap[pattern];
+    var actionName = "set" + (0, _startCase.default)(field);
+    dispatch({
+      type: actionName,
+      value: value
+    });
+    callback === null || callback === void 0 ? void 0 : callback(toDate(field, value));
+  }, [toDate, dispatch]);
+  var getDateField = (0, _react.useCallback)(function (pattern) {
+    var fieldName = _DateField.patternMap[pattern];
+    return {
+      name: fieldName,
+      value: dateField[fieldName]
+    };
+  }, [dateField]);
+  var toControlledDateString = (0, _react.useCallback)(function () {
+    return (0, _dateUtils.format)(date || new Date(), formatStr);
+  }, [date, formatStr]);
+  return {
+    dateField: dateField,
+    setDateOffset: setDateOffset,
+    setDateField: setDateField,
+    getDateField: getDateField,
+    toDateString: isControlledDate ? toControlledDateString : toDateString
+  };
+}
+var _default = useDateInputState;
+exports.default = _default;

package/cjs/DateInput/utils.d.ts

@@ -0,0 +1,41 @@
+import { type Locale } from 'date-fns';
+interface SelectedStateOptions {
+    /**
+     * The input element
+     */
+    input: HTMLInputElement;
+    /**
+     * The direction of the arrow key, left or right
+     */
+    direction?: 'left' | 'right';
+    /**
+     * Format of the string is based on Unicode Technical Standard: https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
+     */
+    formatStr: string;
+    /**
+     * The locale object, date-fns locale object
+     */
+    localize: Locale['localize'];
+    /**
+     * The selected month, used to calculate the offset of the character selection range
+     */
+    selectedMonth: number | null;
+    /**
+     * The offset of the value, which is used to calculate the month.
+     * This value will be changed when pressing the up and down arrow keys.
+     */
+    valueOffset?: number;
+    /**
+     * The date is rendered in string format according to format
+     */
+    dateString: string;
+}
+export declare function getPatternGroups(format: string, pattern: string): string;
+export declare function getInputSelectedState(options: SelectedStateOptions): {
+    selectionStart: number;
+    selectionEnd: number;
+    selectedPattern: string;
+};
+export declare function validateDateTime(type: string, value: number): boolean;
+export declare function modifyDate(date: Date, type: string, value: number): Date;
+export {};

package/cjs/DateInput/utils.js

@@ -0,0 +1,159 @@
+'use client';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.getPatternGroups = getPatternGroups;
+exports.getInputSelectedState = getInputSelectedState;
+exports.validateDateTime = validateDateTime;
+exports.modifyDate = modifyDate;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _dateUtils = require("../utils/dateUtils");
+function getPatternGroups(format, pattern) {
+  var _format$match;
+  return ((_format$match = format.match(new RegExp("(" + pattern + ")+"))) === null || _format$match === void 0 ? void 0 : _format$match[0]) || '';
+}
+function getInputSelectedState(options) {
+  var input = options.input,
+    direction = options.direction,
+    formatStr = options.formatStr,
+    localize = options.localize,
+    selectedMonth = options.selectedMonth,
+    dateString = options.dateString,
+    _options$valueOffset = options.valueOffset,
+    valueOffset = _options$valueOffset === void 0 ? 0 : _options$valueOffset;
+  var getSelectIndexGap = function getSelectIndexGap(pattern) {
+    var gap = 0;
+    var monthIsAbbreviated = formatStr.includes('MMM');
+    var monthIsFull = formatStr.includes('MMMM');
+
+    // If the month is abbreviated or full, the gap needs to be adjusted.
+    if (monthIsAbbreviated || monthIsFull) {
+      var isSelected = pattern === 'M';
+      if (selectedMonth === null && valueOffset === 0) {
+        return gap;
+      }
+      var month = selectedMonth ? selectedMonth + (isSelected ? valueOffset : 0) : 1;
+      if (month > 12) {
+        month = 1;
+      } else if (month === 0) {
+        month = 12;
+      }
+      var monthStr = localize === null || localize === void 0 ? void 0 : localize.month(month - 1, {
+        width: monthIsFull ? 'wide' : 'abbreviated'
+      });
+      gap = monthStr.length - (monthIsFull ? 4 : 3);
+    }
+    return gap;
+  };
+  var getDatePattern = function getDatePattern(selectionIndex, positionOffset) {
+    if (positionOffset === void 0) {
+      positionOffset = -1;
+    }
+    var pattern = formatStr.charAt((input === null || input === void 0 ? void 0 : input.selectionStart) || 0);
+    if (selectionIndex < 0 || selectionIndex > dateString.length - 1) {
+      pattern = formatStr.trim().charAt(0);
+      return pattern;
+    }
+    var gap = getSelectIndexGap(pattern);
+    pattern = formatStr.charAt(selectionIndex - gap);
+
+    // If the pattern is not a letter, then get the pattern from the previous or next letter.
+    if (!pattern.match(/[y|d|M|H|h|m|s|a]/)) {
+      var nextIndex = selectionIndex + positionOffset;
+      pattern = getDatePattern(nextIndex, positionOffset);
+    }
+    return pattern;
+  };
+  var getPatternSelectedIndexes = function getPatternSelectedIndexes(pattern) {
+    var selectionStart = formatStr.indexOf(pattern);
+    var selectionEnd = formatStr.lastIndexOf(pattern) + 1;
+    var gap = getSelectIndexGap(pattern);
+    if (pattern === 'M') {
+      return {
+        selectionStart: selectionStart,
+        selectionEnd: selectionEnd + gap
+      };
+    }
+    return {
+      selectionStart: selectionStart + gap,
+      selectionEnd: selectionEnd + gap
+    };
+  };
+  if (typeof input.selectionEnd === 'number' && typeof input.selectionStart === 'number') {
+    var index = input.selectionStart;
+    var positionOffset = -1;
+    if (direction === 'left') {
+      index = input.selectionStart - 1;
+    } else if (direction === 'right') {
+      index = input.selectionEnd + 1;
+      positionOffset = 1;
+    }
+    var datePattern = getDatePattern(index, positionOffset);
+    var indexes = getPatternSelectedIndexes(datePattern);
+    return (0, _extends2.default)({
+      selectedPattern: datePattern
+    }, indexes);
+  }
+  return {
+    selectedPattern: 'y',
+    selectionStart: 0,
+    selectionEnd: 0
+  };
+}
+function validateDateTime(type, value) {
+  switch (type) {
+    case 'year':
+      if (value < 1 || value > 9999) {
+        return false;
+      }
+      break;
+    case 'month':
+      if (value < 1 || value > 12) {
+        return false;
+      }
+      break;
+    case 'day':
+      if (value < 1 || value > 31) {
+        return false;
+      }
+      break;
+    case 'hour':
+      if (value < 0 || value > 23) {
+        return false;
+      }
+      break;
+    case 'minute':
+      if (value < 0 || value > 59) {
+        return false;
+      }
+      break;
+    case 'second':
+      if (value < 0 || value > 59) {
+        return false;
+      }
+      break;
+    default:
+      return false;
+    // Invalid type
+  }
+
+  return true;
+}
+function modifyDate(date, type, value) {
+  switch (type) {
+    case 'year':
+      return (0, _dateUtils.setYear)(date, value);
+    case 'month':
+      return (0, _dateUtils.setMonth)(date, value - 1);
+    case 'day':
+      return (0, _dateUtils.setDate)(date, value);
+    case 'hour':
+      return (0, _dateUtils.setHours)(date, value);
+    case 'minute':
+      return (0, _dateUtils.setMinutes)(date, value);
+    case 'second':
+      return (0, _dateUtils.setSeconds)(date, value);
+  }
+  return date;
+}

package/cjs/DatePicker/DatePicker.d.ts

@@ -101,5 +101,10 @@ export interface DatePickerProps extends PickerBaseProps<DatePickerLocale>, Form
     /** Custom render value */
     renderValue?: (value: Date, format: string) => string;
 }
+/**
+ * A date picker allows users to select a date from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-picker
+ */
 declare const DatePicker: RsRefForwardingComponent<'div', DatePickerProps>;
 export default DatePicker;

package/cjs/DatePicker/DatePicker.js

@@ -28,6 +28,11 @@ var _Picker = require("../Picker");
 var _OverlayTrigger = require("../Overlay/OverlayTrigger");
 var _deprecatePropType = require("../utils/deprecatePropType");
 var _utils2 = require("../Calendar/utils");
+/**
+ * A date picker allows users to select a date from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-picker
+ */
 var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,
@@ -49,6 +54,7 @@ var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     limitStartYear = props.limitStartYear,
     overrideLocale = props.locale,
     menuClassName = props.menuClassName,
+    menuStyle = props.menuStyle,
     _props$appearance = props.appearance,
     appearance = _props$appearance === void 0 ? 'default' : _props$appearance,
     _props$placement = props.placement,
@@ -86,7 +92,7 @@ var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     onToggleMonthDropdown = props.onToggleMonthDropdown,
     onToggleTimeDropdown = props.onToggleTimeDropdown,
     onShortcutClick = props.onShortcutClick,
-    rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "className", "classPrefix", "calendarDefaultDate", "cleanable", "editable", "defaultValue", "disabled", "format", "isoWeek", "limitEndYear", "limitStartYear", "locale", "menuClassName", "appearance", "placement", "oneTap", "placeholder", "ranges", "value", "showMeridian", "showWeekNumbers", "style", "toggleAs", "caretAs", "disabledDate", "disabledHours", "disabledMinutes", "disabledSeconds", "shouldDisableDate", "shouldDisableHour", "shouldDisableMinute", "shouldDisableSecond", "renderValue", "onChange", "onChangeCalendarDate", "onClean", "onClose", "onEntered", "onExited", "onNextMonth", "onOk", "onOpen", "onPrevMonth", "onSelect", "onToggleMonthDropdown", "onToggleTimeDropdown", "onShortcutClick"]);
+    rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "className", "classPrefix", "calendarDefaultDate", "cleanable", "editable", "defaultValue", "disabled", "format", "isoWeek", "limitEndYear", "limitStartYear", "locale", "menuClassName", "menuStyle", "appearance", "placement", "oneTap", "placeholder", "ranges", "value", "showMeridian", "showWeekNumbers", "style", "toggleAs", "caretAs", "disabledDate", "disabledHours", "disabledMinutes", "disabledSeconds", "shouldDisableDate", "shouldDisableHour", "shouldDisableMinute", "shouldDisableSecond", "renderValue", "onChange", "onChangeCalendarDate", "onClean", "onClose", "onEntered", "onExited", "onNextMonth", "onOk", "onOpen", "onPrevMonth", "onSelect", "onToggleMonthDropdown", "onToggleTimeDropdown", "onShortcutClick"]);
   var _useCustom = (0, _utils.useCustom)('DatePicker', overrideLocale),
     locale = _useCustom.locale,
     formatDate = _useCustom.formatDate,
@@ -477,15 +483,15 @@ var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var bottomRanges = (ranges === null || ranges === void 0 ? void 0 : ranges.filter(function (range) {
     return (range === null || range === void 0 ? void 0 : range.placement) === 'bottom' || (range === null || range === void 0 ? void 0 : range.placement) === undefined;
   })) || [];
-  var renderDropdownMenu = function renderDropdownMenu(positionProps, speakerRef) {
+  var renderCalendarOverlay = function renderCalendarOverlay(positionProps, speakerRef) {
     var left = positionProps.left,
       top = positionProps.top,
       className = positionProps.className;
     var classes = merge(menuClassName, className, prefix('date-menu'));
-    var styles = {
+    var styles = (0, _extends2.default)({}, menuStyle, {
       left: left,
       top: top
-    };
+    });
     return /*#__PURE__*/_react.default.createElement(_Picker.PickerOverlay, {
       role: "dialog",
       className: classes,
@@ -551,7 +557,7 @@ var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     onClose: handleTriggerClose,
     onEntered: (0, _utils.createChainedFunction)(handleEntered, onEntered),
     onExited: (0, _utils.createChainedFunction)(handleExited, onExited),
-    speaker: renderDropdownMenu
+    speaker: renderCalendarOverlay
   }, /*#__PURE__*/_react.default.createElement(Component, {
     className: merge(className, classes),
     style: style,

package/cjs/DateRangePicker/DateRangePicker.d.ts

@@ -70,5 +70,10 @@ export interface DateRangePicker extends PickerComponent<DateRangePickerProps> {
     /** Used to combine multiple conditions */
     combine?: (...args: any) => DisabledDateFunction;
 }
+/**
+ * A date range picker allows you to select a date range from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-range-picker
+ */
 declare const DateRangePicker: DateRangePicker;
 export default DateRangePicker;

package/cjs/DateRangePicker/DateRangePicker.js

@@ -27,6 +27,11 @@ var disabledDateUtils = _interopRequireWildcard(require("./disabledDateUtils"));
 var _utils2 = require("./utils");
 var _deprecatePropType = require("../utils/deprecatePropType");
 var _DateRangePickerContext = _interopRequireDefault(require("./DateRangePickerContext"));
+/**
+ * A date range picker allows you to select a date range from a calendar.
+ *
+ * @see https://rsuitejs.com/components/date-range-picker
+ */
 var DateRangePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _ref, _ref2, _merge;
   var _props$as = props.as,

package/cjs/Divider/Divider.d.ts

@@ -5,5 +5,9 @@ export interface DividerProps extends WithAsProps {
      */
     vertical?: boolean;
 }
+/**
+ * The Divider component is used to separate content.
+ * @see https://rsuitejs.com/components/divider
+ */
 declare const Divider: RsRefForwardingComponent<'div', DividerProps>;
 export default Divider;

package/cjs/Divider/Divider.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 Divider component is used to separate content.
+ * @see https://rsuitejs.com/components/divider
+ */
 var Divider = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$as = props.as,
     Component = _props$as === void 0 ? 'div' : _props$as,

package/cjs/Drawer/Drawer.d.ts

@@ -22,5 +22,9 @@ interface DrawerComponent extends React.FC<DrawerProps> {
      */
     Footer: typeof DrawerFooter;
 }
+/**
+ * The Drawer component is used to display extra content from a main content.
+ * @see https://rsuitejs.com/components/drawer
+ */
 declare const Drawer: DrawerComponent;
 export default Drawer;

package/cjs/Drawer/Drawer.js

@@ -49,6 +49,10 @@ var DrawerTitle = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     ref: ref
   }));
 });
+/**
+ * The Drawer component is used to display extra content from a main content.
+ * @see https://rsuitejs.com/components/drawer
+ */
 var Drawer = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var className = props.className,
     _props$placement = props.placement,

package/cjs/Dropdown/Dropdown.d.ts

@@ -62,9 +62,12 @@ export interface DropdownComponent extends RsRefForwardingComponent<'div', Dropd
     Separator: typeof DropdownSeparator;
 }
 /**
- * The <Dropdown> API
- * When used inside <Sidenav>, renders a <TreeviewRootItem>;
- * Otherwise renders a <MenuRoot>
+ * The `Dropdown` component is used to select an option from a set of options.
+ * @see https://rsuitejs.com/components/dropdown
+ *
+ * The `<Dropdown>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewRootItem>`;
+ * - Otherwise renders a `<MenuRoot>`
  */
 declare const Dropdown: DropdownComponent;
 export default Dropdown;

package/cjs/Dropdown/Dropdown.js

@@ -25,9 +25,12 @@ var _warnOnce = _interopRequireDefault(require("../utils/warnOnce"));
 var _Nav = _interopRequireDefault(require("../Nav"));
 var _DropdownSeparator = _interopRequireDefault(require("./DropdownSeparator"));
 /**
- * The <Dropdown> API
- * When used inside <Sidenav>, renders a <TreeviewRootItem>;
- * Otherwise renders a <MenuRoot>
+ * The `Dropdown` component is used to select an option from a set of options.
+ * @see https://rsuitejs.com/components/dropdown
+ *
+ * The `<Dropdown>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewRootItem>`;
+ * - Otherwise renders a `<MenuRoot>`
  */
 var Dropdown = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var activeKey = props.activeKey,

package/cjs/Dropdown/DropdownItem.d.ts

@@ -39,9 +39,9 @@ export interface DropdownMenuItemProps<T = any> extends WithAsProps, Omit<React.
     onSelect?: (eventKey: T, event: React.SyntheticEvent) => void;
 }
 /**
- * The <Dropdown.Item> API
- * When used inside <Sidenav>, renders a <TreeviewItem>
- * Otherwise renders a <MenuItem>
+ * The `<Dropdown.Item>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewItem>`
+ * - Otherwise renders a `<MenuItem>`
  */
 declare const DropdownItem: RsRefForwardingComponent<'li', DropdownMenuItemProps>;
 export default DropdownItem;

package/cjs/Dropdown/DropdownItem.js

@@ -23,9 +23,9 @@ var _warnOnce = _interopRequireDefault(require("../utils/warnOnce"));
 var _Nav = _interopRequireDefault(require("../Nav"));
 var _DropdownSeparator = _interopRequireDefault(require("./DropdownSeparator"));
 /**
- * The <Dropdown.Item> API
- * When used inside <Sidenav>, renders a <TreeviewItem>
- * Otherwise renders a <MenuItem>
+ * The `<Dropdown.Item>` API
+ * - When used inside `<Sidenav>`, renders a `<TreeviewItem>`
+ * - Otherwise renders a `<MenuItem>`
  */
 var DropdownItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var _props$classPrefix = props.classPrefix,