rsuite 5.31.1 → 5.33.0

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.js

@@ -50,5 +50,5 @@ function getDataGroupBy(data, key, sort) {
     nextData = nextData.sort(sort(true));
   }
 
-  return (0, _treeUtils.flattenTree)(nextData);
+  return (0, _treeUtils.UNSAFE_flattenTree)(nextData);
 }

package/cjs/utils/treeUtils.d.ts

@@ -16,8 +16,12 @@ export declare function shouldShowNodeByParentExpanded<T>(expandItemValues?: T[]
  * @param {*} tree
  * @param {*} childrenKey
  * @param {*} executor
+ *
+ * @deprecated This {@link UNSAFE_flattenTree} function is considered unsafe because it mutates `tree` argument in-place
+ *             Use {@link flattenTree} instead.
  */
-export declare function flattenTree<TItem>(tree: TItem[], childrenKey?: string, executor?: (node: any, index: number) => any): TItem[];
+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[];
 /**
  * get all ancestor nodes of given node
  * @param {*} node
@@ -274,3 +278,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 hirearchy path from root towards `target` item
+ */
+export declare function getPathTowardsItem<T>(target: T | undefined, getParent: (item: T) => T | undefined): T[];

package/cjs/utils/treeUtils.js

@@ -6,6 +6,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 exports.__esModule = true;
 exports.shouldShowNodeByParentExpanded = shouldShowNodeByParentExpanded;
+exports.UNSAFE_flattenTree = UNSAFE_flattenTree;
 exports.flattenTree = flattenTree;
 exports.getNodeParents = getNodeParents;
 exports.getNodeParentKeys = getNodeParentKeys;
@@ -38,6 +39,9 @@ exports.getNodeFormattedRefKey = getNodeFormattedRefKey;
 exports.createDragPreview = createDragPreview;
 exports.removeDragPreview = removeDragPreview;
 exports.stringifyTreeNodeLabel = stringifyTreeNodeLabel;
+exports.getParentMap = getParentMap;
+exports.getKeyParentMap = getKeyParentMap;
+exports.getPathTowardsItem = getPathTowardsItem;
 exports.getScrollToIndex = exports.focusPreviousItem = exports.focusNextItem = exports.focusTreeNode = exports.getElementByDataKey = exports.getActiveItem = exports.getActiveIndex = exports.getFocusableItems = void 0;
 
 var _extends3 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
@@ -72,6 +76,12 @@ var _constants = require("./constants");
 
 var _attachParent = require("./attachParent");
 
+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; }
+
 // gap of tree node
 var TREE_NODE_GAP = 4;
 /**
@@ -102,10 +112,13 @@ function shouldShowNodeByParentExpanded(expandItemValues, parentKeys) {
  * @param {*} tree
  * @param {*} childrenKey
  * @param {*} executor
+ *
+ * @deprecated This {@link UNSAFE_flattenTree} function is considered unsafe because it mutates `tree` argument in-place
+ *             Use {@link flattenTree} instead.
  */
 
 
-function flattenTree(tree, childrenKey, executor) {
+function UNSAFE_flattenTree(tree, childrenKey, executor) {
   if (childrenKey === void 0) {
     childrenKey = 'children';
   }
@@ -130,6 +143,27 @@ function flattenTree(tree, childrenKey, executor) {
   traverse(tree, null);
   return flattenData;
 }
+
+function flattenTree(rootNodes, getChildren) {
+  var result = [];
+  walkTree(rootNodes, getChildren, function (node) {
+    return result.push(node);
+  });
+  return result;
+}
+
+function walkTree(rootNodes, getChildren, callback) {
+  for (var queue = [].concat(rootNodes); queue.length > 0;) {
+    var _node = queue.shift();
+
+    callback(_node);
+    var children = getChildren(_node);
+
+    if (children) {
+      queue.push.apply(queue, children);
+    }
+  }
+}
 /**
  * get all ancestor nodes of given node
  * @param {*} node
@@ -212,7 +246,7 @@ function getDefaultExpandItemValues(data, props) {
       defaultExpandItemValues = _props$defaultExpandI === void 0 ? [] : _props$defaultExpandI;
 
   if (defaultExpandAll) {
-    return flattenTree(data, childrenKey).filter(function (item) {
+    return UNSAFE_flattenTree(data, childrenKey).filter(function (item) {
       return Array.isArray(item[childrenKey]) && item[childrenKey].length > 0;
     }).map(function (item) {
       return item[valueKey];
@@ -379,10 +413,10 @@ function findNodeOfTree(data, check) {
       var _item3 = nodes[i];
 
       if ((0, _isArray2.default)(_item3.children)) {
-        var _node = findNode(_item3.children);
+        var _node2 = findNode(_item3.children);
 
-        if (_node) {
-          return _node;
+        if (_node2) {
+          return _node2;
         }
       }
 
@@ -875,7 +909,7 @@ function useFlattenTreeData(_ref8) {
   var formatVirtualizedTreeData = function formatVirtualizedTreeData(nodes, data, expandItemValues, options) {
     var cascade = options.cascade,
         searchKeyword = options.searchKeyword;
-    return flattenTree(data, childrenKey, function (node) {
+    return UNSAFE_flattenTree(data, childrenKey, function (node) {
       var formatted = {};
       var curNode = nodes === null || nodes === void 0 ? void 0 : nodes[node.refKey];
       var parentKeys = getNodeParentKeys(nodes, curNode, valueKey);
@@ -1170,4 +1204,73 @@ function stringifyTreeNodeLabel(label) {
   }
 
   return '';
+}
+/**
+ * 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 _item5 = queue.shift();
+
+    var children = getChildren(_item5);
+
+    if (children) {
+      for (var _iterator = _createForOfIteratorHelperLoose(children), _step; !(_step = _iterator()).done;) {
+        var child = _step.value;
+        map.set(child, _item5);
+        queue.push(child);
+      }
+    }
+  }
+
+  return map;
+}
+/**
+ * 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.
+ */
+
+
+function getKeyParentMap(items, getKey, getChildren) {
+  var map = new Map();
+
+  for (var queue = [].concat(items); queue.length > 0;) {
+    var _item6 = queue.shift();
+
+    var children = getChildren(_item6);
+
+    if (children) {
+      for (var _iterator2 = _createForOfIteratorHelperLoose(children), _step2; !(_step2 = _iterator2()).done;) {
+        var child = _step2.value;
+        map.set(getKey(child), _item6);
+        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/utils/useMap.d.ts

@@ -0,0 +1,6 @@
+export declare function useMap<K, V>(): {
+    has(key: K): boolean;
+    get(key: K): V | undefined;
+    set(key: K, value: V): void;
+    clear(): void;
+};

package/cjs/utils/useMap.js

@@ -0,0 +1,35 @@
+"use strict";
+
+exports.__esModule = true;
+exports.useMap = useMap;
+
+var _react = require("react");
+
+function useMap() {
+  var _useState = (0, _react.useState)(function () {
+    return new Map();
+  }),
+      map = _useState[0],
+      setMap = _useState[1];
+
+  return (0, _react.useMemo)(function () {
+    return {
+      has: function has(key) {
+        return map.has(key);
+      },
+      get: function get(key) {
+        return map.get(key);
+      },
+      set: function set(key, value) {
+        setMap(function (prev) {
+          var copy = new Map(prev);
+          copy.set(key, value);
+          return copy;
+        });
+      },
+      clear: function clear() {
+        setMap(new Map());
+      }
+    };
+  }, [map]);
+}