rsuite 5.32.0 → 5.33.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [5.33.1](https://github.com/rsuite/rsuite/compare/v5.33.0...v5.33.1) (2023-05-12)
+
+### Bug Fixes
+
+- **Carousel:** fix index not being reset when children change ([#3185](https://github.com/rsuite/rsuite/issues/3185)) ([3afb746](https://github.com/rsuite/rsuite/commit/3afb7460f5d12b34eb0e7944fa9f5a461b663028))
+- **CheckPicker:** avoid mutating data when groupBy is specified ([#3173](https://github.com/rsuite/rsuite/issues/3173)) ([1a9805a](https://github.com/rsuite/rsuite/commit/1a9805a00cffcb8e527fbeb1df3a346da9a707f0))
+- **DatePicker:** fix defaultValue not changing month on calendar ([#3183](https://github.com/rsuite/rsuite/issues/3183)) ([b0a2b5f](https://github.com/rsuite/rsuite/commit/b0a2b5f5cfe6ea94c1c13f8e9451c5d60f7f5b80))
+- **pickers:** fix keyboard events still responding when readOnly ([#3184](https://github.com/rsuite/rsuite/issues/3184)) ([56e7563](https://github.com/rsuite/rsuite/commit/56e7563b2035be767f5ed8429cd8c3622708abe8))
+
+# [5.33.0](https://github.com/rsuite/rsuite/compare/v5.32.0...v5.33.0) (2023-04-28)
+
+### Features
+
+- **Tree,TreePicker,CheckTree,CheckTreePicker:** add onSelectItem prop ([#3172](https://github.com/rsuite/rsuite/issues/3172)) ([9a5618a](https://github.com/rsuite/rsuite/commit/9a5618a3affb13e70330a5aea253e8b54c67b61b))
+
 # [5.32.0](https://github.com/rsuite/rsuite/compare/v5.31.1...v5.32.0) (2023-04-21)
 
 ### Bug Fixes

package/cjs/Carousel/Carousel.js

@@ -59,13 +59,23 @@ var Carousel = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
 
   var _useControlled = (0, _utils.useControlled)(activeIndexProp, defaultActiveIndex),
       activeIndex = _useControlled[0],
-      setActiveIndex = _useControlled[1];
+      setActiveIndex = _useControlled[1],
+      isControlled = _useControlled[2];
 
   var _useState = (0, _react.useState)(0),
       lastIndex = _useState[0],
       setLastIndex = _useState[1];
 
-  var rootRef = (0, _react.useRef)(null); // Set a timer for automatic playback.
+  var rootRef = (0, _react.useRef)(null);
+  (0, _utils.useUpdateEffect)(function () {
+    // When the index is controlled, the index is not updated when the number of children changes.
+    if (isControlled) {
+      return;
+    } // Reset the index when the number of children changes.
+
+
+    setActiveIndex(0);
+  }, [children, isControlled]); // Set a timer for automatic playback.
   // `autoplay` needs to be cast to boolean type to avoid undefined parameters.
 
   var _useTimeout = (0, _utils.useTimeout)(function () {

package/cjs/Cascader/Cascader.js

@@ -111,7 +111,7 @@ var Cascader = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
   var loadingItemsSet = (0, _reactUseSet.useSet)();
   var asyncChildrenMap = (0, _useMap.useMap)();
   var parentMap = (0, _react.useMemo)(function () {
-    return (0, _utils.getParentMap)(data, function (item) {
+    return (0, _treeUtils.getParentMap)(data, function (item) {
       var _asyncChildrenMap$get;
 
       return (_asyncChildrenMap$get = asyncChildrenMap.get(item)) !== null && _asyncChildrenMap$get !== void 0 ? _asyncChildrenMap$get : item[childrenKey];
@@ -365,7 +365,7 @@ var Cascader = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
 
   var renderSearchRow = function renderSearchRow(item, key) {
     var regx = new RegExp((0, _utils2.getSafeRegExpString)(searchKeyword), 'ig');
-    var nodes = (0, _utils.getPathTowardsItem)(item, function (item) {
+    var nodes = (0, _treeUtils.getPathTowardsItem)(item, function (item) {
       return parentMap.get(item);
     });
     var formattedNodes = nodes.map(function (node) {

package/cjs/Cascader/utils.d.ts

@@ -46,13 +46,4 @@ export declare function usePaths<T extends Record<string, unknown>>({ data, acti
     pathTowardsSelectedItem: T[];
     pathTowardsActiveItem: T[];
 };
-/**
- * Returns a WeakMap that maps each item in `items` to its parent
- * indicated by `getChildren` function
- */
-export declare function getParentMap<T extends Record<string, unknown>>(items: readonly T[], getChildren: (item: T) => readonly T[] | undefined): WeakMap<T, T>;
-/**
- * Returns an array indicating the hirearchy path from root towards `target` item
- */
-export declare function getPathTowardsItem<T>(target: T | undefined, getParent: (item: T) => T | undefined): T[];
 export {};

package/cjs/Cascader/utils.js

@@ -3,16 +3,10 @@
 exports.__esModule = true;
 exports.getColumnsAndPaths = getColumnsAndPaths;
 exports.usePaths = usePaths;
-exports.getParentMap = getParentMap;
-exports.getPathTowardsItem = getPathTowardsItem;
 
 var _react = require("react");
 
-function _createForOfIteratorHelperLoose(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (it) return (it = it.call(o)).next.bind(it); if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; return function () { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+var _treeUtils = require("../utils/treeUtils");
 
 /**
  * Calculate columns to be displayed:
@@ -76,7 +70,7 @@ function usePaths(_ref) {
       getParent = _ref.getParent,
       getChildren = _ref.getChildren;
   var pathTowardsSelectedItem = (0, _react.useMemo)(function () {
-    return getPathTowardsItem(selectedItem, getParent);
+    return (0, _treeUtils.getPathTowardsItem)(selectedItem, getParent);
   }, [getParent, selectedItem]);
 
   var _useMemo = (0, _react.useMemo)(function () {
@@ -93,44 +87,4 @@ function usePaths(_ref) {
     pathTowardsSelectedItem: pathTowardsSelectedItem,
     pathTowardsActiveItem: pathTowardsActiveItem
   };
-}
-/**
- * Returns a WeakMap that maps each item in `items` to its parent
- * indicated by `getChildren` function
- */
-
-
-function getParentMap(items, getChildren) {
-  var map = new WeakMap();
-
-  for (var queue = [].concat(items); queue.length > 0;) {
-    var _item = queue.shift();
-
-    var children = getChildren(_item);
-
-    if (children) {
-      for (var _iterator = _createForOfIteratorHelperLoose(children), _step; !(_step = _iterator()).done;) {
-        var child = _step.value;
-        map.set(child, _item);
-        queue.push(child);
-      }
-    }
-  }
-
-  return map;
-}
-/**
- * Returns an array indicating the hirearchy path from root towards `target` item
- */
-
-
-function getPathTowardsItem(target, getParent) {
-  if (!target) return [];
-  var path = [target];
-
-  for (var parent = getParent(target); !!parent; parent = getParent(parent)) {
-    path.unshift(parent);
-  }
-
-  return path;
 }

package/cjs/CheckPicker/CheckPicker.js

@@ -35,6 +35,8 @@ var _treeUtils = require("../utils/treeUtils");
 
 var _utils = require("../utils");
 
+var _getDataGroupBy = require("../utils/getDataGroupBy");
+
 var _Picker = require("../Picker");
 
 var _templateObject;
@@ -323,7 +325,7 @@ var CheckPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
 
 
     if (groupBy) {
-      items = (0, _utils.getDataGroupBy)(items, groupBy, sort);
+      items = (0, _getDataGroupBy.getDataGroupBy)(items, groupBy, sort);
     } else if (typeof sort === 'function') {
       items = items.sort(sort(false));
     }
@@ -342,8 +344,10 @@ var CheckPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       dropdownMenuItemAs: _Picker.DropdownMenuCheckItem,
       activeItemValues: value,
       focusItemValue: focusItemValue,
-      data: [].concat(filteredStickyItems, items),
+      data: [].concat(filteredStickyItems, items) // `group` is redundant so long as `groupBy` exists
+      ,
       group: !(0, _isUndefined.default)(groupBy),
+      groupBy: groupBy,
       onSelect: handleItemSelect,
       onGroupTitleClick: onGroupTitleClick,
       virtualized: virtualized

package/cjs/CheckTreePicker/CheckTreePicker.js

@@ -117,13 +117,14 @@ var CheckTreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, re
       onExited = props.onExited,
       onSearch = props.onSearch,
       onSelect = props.onSelect,
+      onSelectItem = props.onSelectItem,
       onOpen = props.onOpen,
       onScroll = props.onScroll,
       onExpand = props.onExpand,
       renderValue = props.renderValue,
       renderTreeIcon = props.renderTreeIcon,
       renderTreeNode = props.renderTreeNode,
-      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "data", "style", "appearance", "cleanable", "countable", "searchBy", "toggleAs", "searchKeyword", "showIndentLine", "locale", "cascade", "disabled", "valueKey", "labelKey", "placement", "childrenKey", "placeholder", "value", "defaultValue", "defaultExpandAll", "disabledItemValues", "expandItemValues", "defaultExpandItemValues", "height", "menuMaxHeight", "menuStyle", "searchable", "virtualized", "className", "classPrefix", "menuClassName", "menuAutoWidth", "uncheckableItemValues", "id", "listProps", "renderMenu", "getChildren", "renderExtraFooter", "onEntered", "onChange", "onClean", "onClose", "onExited", "onSearch", "onSelect", "onOpen", "onScroll", "onExpand", "renderValue", "renderTreeIcon", "renderTreeNode"]);
+      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "data", "style", "appearance", "cleanable", "countable", "searchBy", "toggleAs", "searchKeyword", "showIndentLine", "locale", "cascade", "disabled", "valueKey", "labelKey", "placement", "childrenKey", "placeholder", "value", "defaultValue", "defaultExpandAll", "disabledItemValues", "expandItemValues", "defaultExpandItemValues", "height", "menuMaxHeight", "menuStyle", "searchable", "virtualized", "className", "classPrefix", "menuClassName", "menuAutoWidth", "uncheckableItemValues", "id", "listProps", "renderMenu", "getChildren", "renderExtraFooter", "onEntered", "onChange", "onClean", "onClose", "onExited", "onSearch", "onSelect", "onSelectItem", "onOpen", "onScroll", "onExpand", "renderValue", "renderTreeIcon", "renderTreeNode"]);
 
   var _useContext = (0, _react.useContext)(_TreeContext.default),
       inline = _useContext.inline;
@@ -368,7 +369,16 @@ var CheckTreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, re
     return values.filter(function (v) {
       return !uncheckableItemValues.includes(v);
     });
-  }, [flattenNodes, uncheckableItemValues, serializeListOnlyParent, toggleDownChecked, toggleUpChecked]);
+  }, [flattenNodes, uncheckableItemValues, serializeListOnlyParent, toggleDownChecked, toggleUpChecked]); // TODO-Doma
+  // Replace `getKeyParentMap` with `getParentMap`
+
+  var itemParentMap = (0, _react.useMemo)(function () {
+    return (0, _treeUtils.getKeyParentMap)(data, function (node) {
+      return node[valueKey];
+    }, function (node) {
+      return node[childrenKey];
+    });
+  }, [childrenKey, data, valueKey]);
   var handleSelect = (0, _react.useCallback)(function (node, event) {
     var currentNode = node.refKey ? flattenNodes[node.refKey] : null;
 
@@ -393,7 +403,10 @@ var CheckTreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, re
     setFocusItemValue(node[valueKey]);
     onChange === null || onChange === void 0 ? void 0 : onChange(selectedValues, event);
     onSelect === null || onSelect === void 0 ? void 0 : onSelect(node, selectedValues, event);
-  }, [cascade, valueKey, flattenNodes, isControlled, uncheckableItemValues, setValue, onChange, onSelect, toggleChecked, unSerializeList]);
+    onSelectItem === null || onSelectItem === void 0 ? void 0 : onSelectItem(node, (0, _treeUtils.getPathTowardsItem)(node, function (item) {
+      return itemParentMap.get(item[valueKey]);
+    }));
+  }, [flattenNodes, toggleChecked, isControlled, valueKey, onChange, onSelect, onSelectItem, unSerializeList, cascade, uncheckableItemValues, setValue, itemParentMap]);
   var handleOpen = (0, _react.useCallback)(function () {
     var _triggerRef$current, _triggerRef$current$o;
 

package/cjs/DatePicker/DatePicker.js

@@ -117,7 +117,7 @@ var DatePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       value = _useControlled[0],
       setValue = _useControlled[1];
 
-  var _useCalendarDate = (0, _useCalendarDate2.default)(valueProp, calendarDefaultDate),
+  var _useCalendarDate = (0, _useCalendarDate2.default)(value, calendarDefaultDate),
       calendarDate = _useCalendarDate.calendarDate,
       setCalendarDate = _useCalendarDate.setCalendarDate,
       resetCalendarDate = _useCalendarDate.resetCalendarDate;

package/cjs/InputPicker/InputPicker.js

@@ -43,6 +43,8 @@ var _Plaintext = _interopRequireDefault(require("../Plaintext"));
 
 var _utils = require("../utils");
 
+var _getDataGroupBy = require("../utils/getDataGroupBy");
+
 var _Picker = require("../Picker");
 
 var _Tag = _interopRequireDefault(require("../Tag"));
@@ -629,7 +631,7 @@ var InputPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
 
 
     if (groupBy) {
-      items = (0, _utils.getDataGroupBy)(items, groupBy, sort);
+      items = (0, _getDataGroupBy.getDataGroupBy)(items, groupBy, sort);
     } else if (typeof sort === 'function') {
       items = items.sort(sort(false));
     }
@@ -653,8 +655,11 @@ var InputPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       activeItemValues: multi ? value : [value],
       focusItemValue: focusItemValue,
       maxHeight: menuMaxHeight,
-      data: items,
+      data: items // FIXME-Doma
+      // `group` is redundant so long as `groupBy` exists
+      ,
       group: !(0, _isUndefined.default)(groupBy),
+      groupBy: groupBy,
       onSelect: multi ? handleCheckTag : handleSelectItem // fixme don't use any
       ,
       renderMenuGroup: renderMenuGroup,

package/cjs/MultiCascader/MultiCascader.js

@@ -249,6 +249,7 @@ var MultiCascader = /*#__PURE__*/_react.default.forwardRef(function (props, ref)
     (_triggerRef$current = triggerRef.current) === null || _triggerRef$current === void 0 ? void 0 : (_triggerRef$current$u = _triggerRef$current.updatePosition) === null || _triggerRef$current$u === void 0 ? void 0 : _triggerRef$current$u.call(_triggerRef$current);
   }, [onSelect, getChildren, childrenKey, inline, addFlattenData, addColumn, removeColumnByIndex]);
   var handleCheck = (0, _react.useCallback)(function (node, event, checked) {
+    console.log('handleCheck');
     var nodeValue = node[valueKey];
     var nextValue = [];
 

package/cjs/Picker/DropdownMenu.d.ts

@@ -6,6 +6,7 @@ export interface DropdownMenuProps<Multiple = false> extends StandardProps, Omit
     classPrefix: string;
     data?: ItemDataType[];
     group?: boolean;
+    groupBy?: string;
     disabledItemValues?: any[];
     activeItemValues?: any[];
     focusItemValue?: any;

package/cjs/Picker/DropdownMenu.js

@@ -11,6 +11,8 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 
 var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
 
+var _get2 = _interopRequireDefault(require("lodash/get"));
+
 var _react = _interopRequireWildcard(require("react"));
 
 var _propTypes = _interopRequireDefault(require("prop-types"));
@@ -47,6 +49,7 @@ var DropdownMenu = /*#__PURE__*/_react.default.forwardRef(function (props, ref)
   var _props$data = props.data,
       data = _props$data === void 0 ? [] : _props$data,
       group = props.group,
+      groupBy = props.groupBy,
       _props$maxHeight = props.maxHeight,
       maxHeight = _props$maxHeight === void 0 ? 320 : _props$maxHeight,
       _props$activeItemValu = props.activeItemValues,
@@ -75,7 +78,7 @@ var DropdownMenu = /*#__PURE__*/_react.default.forwardRef(function (props, ref)
       renderMenuItem = props.renderMenuItem,
       onGroupTitleClick = props.onGroupTitleClick,
       onSelect = props.onSelect,
-      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["data", "group", "maxHeight", "activeItemValues", "disabledItemValues", "classPrefix", "valueKey", "labelKey", "virtualized", "listProps", "listRef", "className", "style", "focusItemValue", "dropdownMenuItemClassPrefix", "dropdownMenuItemAs", "rowHeight", "rowGroupHeight", "renderMenuGroup", "renderMenuItem", "onGroupTitleClick", "onSelect"]);
+      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["data", "group", "groupBy", "maxHeight", "activeItemValues", "disabledItemValues", "classPrefix", "valueKey", "labelKey", "virtualized", "listProps", "listRef", "className", "style", "focusItemValue", "dropdownMenuItemClassPrefix", "dropdownMenuItemAs", "rowHeight", "rowGroupHeight", "renderMenuGroup", "renderMenuItem", "onGroupTitleClick", "onSelect"]);
 
   var _useClassNames = (0, _utils.useClassNames)(classPrefix),
       withClassPrefix = _useClassNames.withClassPrefix,
@@ -205,11 +208,21 @@ var DropdownMenu = /*#__PURE__*/_react.default.forwardRef(function (props, ref)
   };
 
   var filteredItems = group ? data.filter(function (item) {
-    return !(foldedGroupKeys !== null && foldedGroupKeys !== void 0 && foldedGroupKeys.some(function (key) {
-      var _item$parent;
-
-      return key === ((_item$parent = item.parent) === null || _item$parent === void 0 ? void 0 : _item$parent[_getDataGroupBy.KEY_GROUP_TITLE]);
-    }));
+    var _item$parent;
+
+    // Display group title items
+    if (item[_getDataGroupBy.KEY_GROUP]) return true; // Display items under the unfolded group
+    // FIXME-Doma
+    // `groupBy` is bound to be string when `group` is true
+    // because `group` is actually redundant as a prop
+    // It could simply be derived from `groupBy` value
+
+    var groupValue = (0, _get2.default)(item, groupBy, '') || ( // FIXME-Doma
+    // Usage of `item.parent` is strongly discouraged
+    // It's only here for legacy support
+    // Remove once `item.parent` is completely removed across related components
+    (_item$parent = item.parent) === null || _item$parent === void 0 ? void 0 : _item$parent[_getDataGroupBy.KEY_GROUP_TITLE]);
+    return !foldedGroupKeys.includes(groupValue);
   }) : data;
   var rowCount = filteredItems.length;
   (0, _utils.useMount)(function () {

package/cjs/Picker/utils.d.ts

@@ -73,6 +73,8 @@ export interface ToggleKeyDownEventProps {
     overlayRef?: React.RefObject<any>;
     searchInputRef?: React.RefObject<any>;
     active?: boolean;
+    readOnly?: boolean;
+    disabled?: boolean;
     onExit?: (event: any) => void;
     onKeyDown?: (event: any) => void;
     onOpen?: () => void;

package/cjs/Picker/utils.js

@@ -433,6 +433,8 @@ var useToggleKeyDownEvent = function useToggleKeyDownEvent(props) {
       overlayRef = props.overlayRef,
       searchInputRef = props.searchInputRef,
       active = props.active,
+      readOnly = props.readOnly,
+      disabled = props.disabled,
       onExit = props.onExit,
       onOpen = props.onOpen,
       onClose = props.onClose,
@@ -461,6 +463,11 @@ var useToggleKeyDownEvent = function useToggleKeyDownEvent(props) {
     handleOpen();
   }, [active, handleOpen, handleClose]);
   var onToggle = (0, _react.useCallback)(function (event) {
+    // Keyboard events should not be processed when readOnly and disabled are set.
+    if (readOnly || disabled) {
+      return;
+    }
+
     if (event.target === (targetRef === null || targetRef === void 0 ? void 0 : targetRef.current)) {
       // enter
       if (toggle && event.key === _utils.KEY_VALUES.ENTER) {
@@ -510,7 +517,7 @@ var useToggleKeyDownEvent = function useToggleKeyDownEvent(props) {
 
 
     onKeyDown === null || onKeyDown === void 0 ? void 0 : onKeyDown(event);
-  }, [handleClose, handleToggleDropdown, overlayRef, onExit, onKeyDown, onMenuKeyDown, onMenuPressBackspace, onMenuPressEnter, toggle, targetRef, searchInputRef]);
+  }, [readOnly, disabled, targetRef, overlayRef, onKeyDown, toggle, handleToggleDropdown, onExit, onMenuKeyDown, searchInputRef, onMenuPressEnter, onMenuPressBackspace, handleClose]);
   return onToggle;
 };
 

package/cjs/SelectPicker/SelectPicker.js

@@ -29,6 +29,8 @@ var _omit = _interopRequireDefault(require("lodash/omit"));
 
 var _utils = require("../utils");
 
+var _getDataGroupBy = require("../utils/getDataGroupBy");
+
 var _Picker = require("../Picker");
 
 var _templateObject;
@@ -258,7 +260,7 @@ var SelectPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref)
     var items = filteredData; // Create a tree structure data when set `groupBy`
 
     if (groupBy) {
-      items = (0, _utils.getDataGroupBy)(items, groupBy, sort);
+      items = (0, _getDataGroupBy.getDataGroupBy)(items, groupBy, sort);
     } else if (typeof sort === 'function') {
       items = items.sort(sort(false));
     }
@@ -278,8 +280,11 @@ var SelectPicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref)
       dropdownMenuItemAs: _Picker.DropdownMenuItem,
       activeItemValues: [value],
       focusItemValue: focusItemValue,
-      data: items,
+      data: items // FIXME-Doma
+      // `group` is redundant so long as `groupBy` exists
+      ,
       group: !(0, _isUndefined.default)(groupBy),
+      groupBy: groupBy,
       onSelect: handleItemSelect,
       onGroupTitleClick: onGroupTitleClick,
       virtualized: virtualized

package/cjs/Tree/Tree.d.ts

@@ -60,6 +60,8 @@ export interface TreeBaseProps<ValueType = string | number, ItemDataType = Recor
     onExpand?: (expandItemValues: ItemDataType[], activeNode: ItemDataType, concat: (data: ItemDataType[], children: ItemDataType[]) => ItemDataType[]) => void;
     /** Callback function after selecting tree node */
     onSelect?: (activeNode: ItemDataType, value: ValueType, event: React.SyntheticEvent) => void;
+    /** Callback when a tree item is clicked */
+    onSelectItem?: (item: ItemDataType, path: ItemDataType[]) => void;
     /** Custom Render tree Node */
     renderTreeNode?: (nodeData: ItemDataType) => React.ReactNode;
     /** Custom Render icon */

package/cjs/TreePicker/TreePicker.js

@@ -104,6 +104,7 @@ var TreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       onOpen = props.onOpen,
       onSearch = props.onSearch,
       onSelect = props.onSelect,
+      onSelectItem = props.onSelectItem,
       onChange = props.onChange,
       onEntered = props.onEntered,
       onClose = props.onClose,
@@ -117,7 +118,7 @@ var TreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       renderExtraFooter = props.renderExtraFooter,
       renderMenu = props.renderMenu,
       renderValue = props.renderValue,
-      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "data", "appearance", "style", "showIndentLine", "value", "locale", "height", "menuMaxHeight", "menuStyle", "className", "disabled", "placement", "cleanable", "searchable", "virtualized", "classPrefix", "defaultValue", "placeholder", "searchKeyword", "menuClassName", "menuAutoWidth", "searchBy", "toggleAs", "labelKey", "valueKey", "childrenKey", "draggable", "defaultExpandAll", "disabledItemValues", "expandItemValues", "defaultExpandItemValues", "id", "listProps", "getChildren", "renderTreeIcon", "renderTreeNode", "onExit", "onExited", "onClean", "onOpen", "onSearch", "onSelect", "onChange", "onEntered", "onClose", "onDragEnd", "onDragStart", "onDragEnter", "onDragLeave", "onDragOver", "onDrop", "onExpand", "renderExtraFooter", "renderMenu", "renderValue"]);
+      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "data", "appearance", "style", "showIndentLine", "value", "locale", "height", "menuMaxHeight", "menuStyle", "className", "disabled", "placement", "cleanable", "searchable", "virtualized", "classPrefix", "defaultValue", "placeholder", "searchKeyword", "menuClassName", "menuAutoWidth", "searchBy", "toggleAs", "labelKey", "valueKey", "childrenKey", "draggable", "defaultExpandAll", "disabledItemValues", "expandItemValues", "defaultExpandItemValues", "id", "listProps", "getChildren", "renderTreeIcon", "renderTreeNode", "onExit", "onExited", "onClean", "onOpen", "onSearch", "onSelect", "onSelectItem", "onChange", "onEntered", "onClose", "onDragEnd", "onDragStart", "onDragEnter", "onDragLeave", "onDragOver", "onDrop", "onExpand", "renderExtraFooter", "renderMenu", "renderValue"]);
   var triggerRef = (0, _react.useRef)(null);
   var targetRef = (0, _react.useRef)(null);
   var listRef = (0, _react.useRef)(null);
@@ -313,8 +314,17 @@ var TreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       onRenderTreeNode: renderTreeNode,
       onRenderTreeIcon: renderTreeIcon
     };
-  };
+  }; // TODO-Doma
+  // Replace `getKeyParentMap` with `getParentMap`
+
 
+  var itemParentMap = (0, _react.useMemo)(function () {
+    return (0, _treeUtils.getKeyParentMap)(data, function (node) {
+      return node[valueKey];
+    }, function (node) {
+      return node[childrenKey];
+    });
+  }, [childrenKey, data, valueKey]);
   var handleSelect = (0, _react.useCallback)(function (nodeData, event) {
     var _targetRef$current, _triggerRef$current, _triggerRef$current$c;
 
@@ -331,9 +341,12 @@ var TreePicker = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
     setFocusItemValue(nodeData[valueKey]);
     onChange === null || onChange === void 0 ? void 0 : onChange(nodeValue, event);
     onSelect === null || onSelect === void 0 ? void 0 : onSelect(nodeData, nodeValue, event);
+    onSelectItem === null || onSelectItem === void 0 ? void 0 : onSelectItem(nodeData, (0, _treeUtils.getPathTowardsItem)(nodeData, function (item) {
+      return itemParentMap.get(item[valueKey]);
+    }));
     (_targetRef$current = targetRef.current) === null || _targetRef$current === void 0 ? void 0 : _targetRef$current.focus();
     (_triggerRef$current = triggerRef.current) === null || _triggerRef$current === void 0 ? void 0 : (_triggerRef$current$c = _triggerRef$current.close) === null || _triggerRef$current$c === void 0 ? void 0 : _triggerRef$current$c.call(_triggerRef$current);
-  }, [valueKey, isControlled, onChange, onSelect, setValue]);
+  }, [valueKey, isControlled, onChange, onSelect, onSelectItem, setValue, itemParentMap]);
   var handleExpand = (0, _react.useCallback)(function (node) {
     var nextExpandItemValues = (0, _treeUtils.toggleExpand)({
       node: node,

package/cjs/utils/getDataGroupBy.d.ts

@@ -1,3 +1,6 @@
 export declare const KEY_GROUP: string | symbol;
 export declare const KEY_GROUP_TITLE = "groupTitle";
-export default function getDataGroupBy(data: any[] | undefined, key: string, sort?: any): any[];
+export declare function getDataGroupBy<T>(data: readonly T[], key: string, sort?: (isGroup: boolean) => <T>(a: T, b: T) => number): (T | {
+    groupTitle: string;
+    children: T[];
+})[];

package/cjs/utils/getDataGroupBy.js

@@ -3,10 +3,10 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
 exports.__esModule = true;
-exports.default = getDataGroupBy;
+exports.getDataGroupBy = getDataGroupBy;
 exports.KEY_GROUP_TITLE = exports.KEY_GROUP = void 0;
 
-var _get2 = _interopRequireDefault(require("lodash/get"));
+var _groupBy2 = _interopRequireDefault(require("lodash/groupBy"));
 
 var _treeUtils = require("../utils/treeUtils");
 
@@ -17,26 +17,9 @@ var KEY_GROUP_TITLE = 'groupTitle';
 exports.KEY_GROUP_TITLE = KEY_GROUP_TITLE;
 
 function getDataGroupBy(data, key, sort) {
-  if (data === void 0) {
-    data = [];
-  }
-
-  var tempData = {};
+  var groupMap = (0, _groupBy2.default)(data, key);
   var isSort = typeof sort === 'function';
-  data.forEach(function (item) {
-    // this will allow getting data using dot notation
-    // i.e groupBy="country.name" as country will be a nested object
-    // to the item and the name will be nested key to the country object
-    // can be used with values in arrays, i.e groupBy="addresses.0.country.name"
-    var groupByValue = (0, _get2.default)(item, key, '');
-
-    if (!tempData[groupByValue]) {
-      tempData[groupByValue] = [];
-    }
-
-    tempData[groupByValue].push(item);
-  });
-  var nextData = Object.entries(tempData).map(function (_ref) {
+  var groups = Object.entries(groupMap).map(function (_ref) {
     var _ref2;
 
     var groupTitle = _ref[0],
@@ -47,8 +30,13 @@ function getDataGroupBy(data, key, sort) {
   });
 
   if (isSort) {
-    nextData = nextData.sort(sort(true));
-  }
+    groups.sort(sort(true));
+  } // Use DFS traverse
+  // Because I want the result to be [group, child, child, group, child, child]
+  // rather than [group, group, child, child, child, child]
+
 
-  return (0, _treeUtils.UNSAFE_flattenTree)(nextData);
+  return (0, _treeUtils.flattenTree)(groups, function (group) {
+    return group.children;
+  }, _treeUtils.WalkTreeStrategy.DFS);
 }

package/cjs/utils/index.d.ts

@@ -12,7 +12,6 @@ export { default as ReactChildren } from './ReactChildren';
 export { default as tplTransform } from './tplTransform';
 export { default as ajaxUpload } from './ajaxUpload';
 export { default as previewFile } from './previewFile';
-export { default as getDataGroupBy } from './getDataGroupBy';
 export { default as clone } from './clone';
 export { default as placementPolyfill } from './placementPolyfill';
 export { default as getDOMNode } from './getDOMNode';

package/cjs/utils/index.js

@@ -14,7 +14,6 @@ var _exportNames = {
   tplTransform: true,
   ajaxUpload: true,
   previewFile: true,
-  getDataGroupBy: true,
   clone: true,
   placementPolyfill: true,
   getDOMNode: true,
@@ -49,7 +48,7 @@ var _exportNames = {
   DateUtils: true,
   TypeChecker: true
 };
-exports.TypeChecker = exports.DateUtils = exports.globalKey = exports.getClassNamePrefix = exports.defaultClassPrefix = exports.useMount = exports.useIsMounted = exports.useUpdateEffect = exports.useWillUnmount = exports.useUpdatedRef = exports.useEventCallback = exports.stringToObject = exports.getSafeRegExpString = exports.useRootClose = exports.useControlled = exports.useTimeout = exports.createComponent = exports.usePortal = exports.useCustom = exports.useElementResize = exports.useEventListener = exports.useClassNames = exports.render = exports.appendTooltip = exports.scrollTopAnimation = exports.reactToString = exports.composeFunctions = exports.shallowEqualArray = exports.shallowEqual = exports.mergeRefs = exports.getDOMNode = exports.placementPolyfill = exports.clone = exports.getDataGroupBy = exports.previewFile = exports.ajaxUpload = exports.tplTransform = exports.ReactChildren = exports.isOneOf = exports.createChainedFunction = exports.prefix = exports.guid = void 0;
+exports.TypeChecker = exports.DateUtils = exports.globalKey = exports.getClassNamePrefix = exports.defaultClassPrefix = exports.useMount = exports.useIsMounted = exports.useUpdateEffect = exports.useWillUnmount = exports.useUpdatedRef = exports.useEventCallback = exports.stringToObject = exports.getSafeRegExpString = exports.useRootClose = exports.useControlled = exports.useTimeout = exports.createComponent = exports.usePortal = exports.useCustom = exports.useElementResize = exports.useEventListener = exports.useClassNames = exports.render = exports.appendTooltip = exports.scrollTopAnimation = exports.reactToString = exports.composeFunctions = exports.shallowEqualArray = exports.shallowEqual = exports.mergeRefs = exports.getDOMNode = exports.placementPolyfill = exports.clone = exports.previewFile = exports.ajaxUpload = exports.tplTransform = exports.ReactChildren = exports.isOneOf = exports.createChainedFunction = exports.prefix = exports.guid = void 0;
 
 var _BrowserDetection = require("./BrowserDetection");
 
@@ -130,10 +129,6 @@ var _previewFile = _interopRequireDefault(require("./previewFile"));
 
 exports.previewFile = _previewFile.default;
 
-var _getDataGroupBy = _interopRequireDefault(require("./getDataGroupBy"));
-
-exports.getDataGroupBy = _getDataGroupBy.default;
-
 var _clone = _interopRequireDefault(require("./clone"));
 
 exports.clone = _clone.default;

package/cjs/utils/treeUtils.d.ts

@@ -21,7 +21,13 @@ export declare function shouldShowNodeByParentExpanded<T>(expandItemValues?: T[]
  *             Use {@link flattenTree} instead.
  */
 export declare function UNSAFE_flattenTree<TItem>(tree: TItem[], childrenKey?: string, executor?: (node: any, index: number) => any): TItem[];
-export declare function flattenTree<T>(rootNodes: readonly T[], getChildren: (node: T) => readonly T[] | undefined): T[];
+export declare enum WalkTreeStrategy {
+    DFS = 0,
+    BFS = 1
+}
+export declare function flattenTree<T>(rootNodes: readonly T[], getChildren: (node: T) => readonly T[] | undefined, walkStrategy?: WalkTreeStrategy): T[];
+export declare function walkTreeBfs<T>(rootNodes: readonly T[], getChildren: (node: T) => readonly T[] | undefined, callback: (node: T) => void): void;
+export declare function walkTreeDfs<T>(rootNodes: readonly T[], getChildren: (node: T) => readonly T[] | undefined, callback: (node: T) => void): void;
 /**
  * get all ancestor nodes of given node
  * @param {*} node
@@ -278,3 +284,21 @@ export declare function createDragPreview(name: string, className: string): HTML
  */
 export declare function removeDragPreview(): void;
 export declare function stringifyTreeNodeLabel(label: string | React.ReactNode): string;
+/**
+ * Returns a WeakMap that maps each item in `items` to its parent
+ * indicated by `getChildren` function
+ */
+export declare function getParentMap<T extends Record<string, unknown>>(items: readonly T[], getChildren: (item: T) => readonly T[] | undefined): WeakMap<T, T>;
+/**
+ * Returns a Map that maps each item's "key", indicated by `getKey` function,
+ * to its parent indicated by `getChildren` function
+ *
+ * NOTICE:
+ * Using this function is discouraged.
+ * Use {@link getParentMap} whenever possible.
+ */
+export declare function getKeyParentMap<T extends Record<string, unknown>, K = React.Key>(items: readonly T[], getKey: (item: T) => K, getChildren: (item: T) => readonly T[] | undefined): Map<K, T>;
+/**
+ * Returns an array indicating the hierarchy path from root towards `target` item
+ */
+export declare function getPathTowardsItem<T>(target: T | undefined, getParent: (item: T) => T | undefined): T[];