@elliemae/ds-treeview 2.3.0-next.0 → 3.0.0-alpha.0

package/{esm → dist/esm}/utils/useInstanceRefActions.js

@@ -1,16 +1,10 @@
-import 'core-js/modules/web.dom-collections.iterator.js';
-import { useRef, useMemo, useState, useEffect, useCallback } from 'react';
-import { focusItem } from './tree-helpers.js';
-import { toggleExpandAllHelper } from './group-expands-helpers.js';
-
-const useInstanceRefActions = (_ref, ctx) => {
-  let {
-    actions
-  } = _ref;
+import * as React from "react";
+import { useEffect, useMemo, useState, useRef, useCallback } from "react";
+import { focusItem } from "./tree-helpers";
+import { toggleExpandAllHelper } from "./group-expands-helpers";
+const useInstanceRefActions = ({ actions }, ctx) => {
   const {
-    props: {
-      onItemFocus
-    },
+    props: { onItemFocus },
     virtualListHelpers,
     treeRoot,
     visibleItems,
@@ -20,12 +14,8 @@ const useInstanceRefActions = (_ref, ctx) => {
     setFocusedItem,
     setLatestToggledItem
   } = ctx;
-  const {
-    current: promises
-  } = useRef({});
-  const {
-    scrollToIndex
-  } = useMemo(() => virtualListHelpers, [virtualListHelpers]);
+  const { current: promises } = useRef({});
+  const { scrollToIndex } = useMemo(() => virtualListHelpers, [virtualListHelpers]);
   const [expandPromise, setPromise] = useState();
   useEffect(() => {
     if (expandPromise && promises.expandResolve) {
@@ -34,36 +24,30 @@ const useInstanceRefActions = (_ref, ctx) => {
       setPromise(null);
     }
   }, [visibleItems, expandPromise, promises]);
-  actions.toggleExpandAll = useCallback(isExpand => {
-    const p = new Promise(resolve => {
+  actions.toggleExpandAll = useCallback((isExpand) => {
+    const p = new Promise((resolve) => {
       promises.expandResolve = resolve;
-      if (treeRoot) toggleExpandAllHelper(isExpand, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState);
+      if (treeRoot)
+        toggleExpandAllHelper(isExpand, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState);
     });
     setPromise(p);
     return p;
   }, [promises, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState]);
-  actions.scrollTo = useCallback(function (indx) {
-    let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
-      align: 'start'
-    };
-    if (scrollToIndex) scrollToIndex(indx, opts);
+  actions.scrollTo = useCallback((indx, opts = { align: "start" }) => {
+    if (scrollToIndex)
+      scrollToIndex(indx, opts);
   }, [scrollToIndex]);
-  actions.setSelectedItemByVirtualIndex = useCallback(index => {
+  actions.setSelectedItemByVirtualIndex = useCallback((index) => {
     const itemByIndex = visibleItems[index];
     setSelectedItem(itemByIndex);
   }, [visibleItems, setSelectedItem]);
-  actions.setFocusedItemByVirtualIndex = useCallback(function (index) {
-    let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
-      align: 'start',
-      withScroll: false
-    };
+  actions.setFocusedItemByVirtualIndex = useCallback((index, opts = { align: "start", withScroll: false }) => {
     const itemByIndex = visibleItems[index];
     const onItemFocusParams = {
       itemIndex: itemByIndex.virtualIndex,
       scrollToItem: () => scrollToIndex(index, opts),
       item: itemByIndex
     };
-
     if (opts.withScroll && scrollToIndex) {
       scrollToIndex(index, opts);
       setTimeout(() => {
@@ -79,5 +63,7 @@ const useInstanceRefActions = (_ref, ctx) => {
   }, [visibleItems, scrollToIndex, setFocusedItem, onItemFocus]);
   return actions;
 };
-
-export { useInstanceRefActions };
+export {
+  useInstanceRefActions
+};
+//# sourceMappingURL=useInstanceRefActions.js.map

package/dist/esm/utils/useInstanceRefActions.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/utils/useInstanceRefActions.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import { useEffect, useMemo, useState, useRef, useCallback } from 'react';\nimport { focusItem } from './tree-helpers';\nimport { toggleExpandAllHelper } from './group-expands-helpers';\nimport type { DSTreeviewT } from '../react-desc-prop-types';\nimport type { DSTreeviewInternalsT } from '../sharedTypes';\n\ninterface PromisesRefT {\n  expandResolve?: null | ((value: DSTreeviewT.Item[] | PromiseLike<DSTreeviewT.Item[]>) => void);\n  scrollTo?: null | ((value: DSTreeviewT.Item[] | PromiseLike<DSTreeviewT.Item[]>) => void);\n}\n\nexport const useInstanceRefActions = ({ actions }: DSTreeviewT.InstanceRef, ctx: DSTreeviewInternalsT.CTX) => {\n  const {\n    props: { onItemFocus },\n    virtualListHelpers,\n    treeRoot,\n    visibleItems,\n    triggerTreeRerender,\n    updateUserExpandedState,\n    setSelectedItem,\n    setFocusedItem,\n    setLatestToggledItem,\n  } = ctx;\n  const { current: promises } = useRef<PromisesRefT>({});\n  const { scrollToIndex } = useMemo(() => virtualListHelpers, [virtualListHelpers]);\n  const [expandPromise, setPromise] = useState<Promise<DSTreeviewT.Item[]> | undefined | null>();\n\n  useEffect(() => {\n    if (expandPromise && promises.expandResolve) {\n      promises.expandResolve(visibleItems);\n      promises.expandResolve = null;\n      setPromise(null);\n    }\n  }, [visibleItems, expandPromise, promises]);\n\n  actions.toggleExpandAll = useCallback(\n    (isExpand) => {\n      const p = new Promise<DSTreeviewT.Item[]>((resolve) => {\n        promises.expandResolve = resolve;\n        if (treeRoot)\n          toggleExpandAllHelper(isExpand, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState);\n      });\n      setPromise(p);\n      return p;\n    },\n    [promises, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState],\n  );\n  actions.scrollTo = useCallback(\n    (indx, opts = { align: 'start' }) => {\n      if (scrollToIndex) scrollToIndex(indx, opts);\n    },\n    [scrollToIndex],\n  );\n\n  actions.setSelectedItemByVirtualIndex = useCallback(\n    (index) => {\n      const itemByIndex = visibleItems[index];\n      setSelectedItem(itemByIndex);\n    },\n    [visibleItems, setSelectedItem],\n  );\n\n  actions.setFocusedItemByVirtualIndex = useCallback(\n    (index, opts = { align: 'start', withScroll: false }) => {\n      const itemByIndex = visibleItems[index];\n      const onItemFocusParams = {\n        itemIndex: itemByIndex.virtualIndex as number,\n        scrollToItem: () => scrollToIndex(index, opts),\n        item: itemByIndex,\n      };\n\n      if (opts.withScroll && scrollToIndex) {\n        scrollToIndex(index, opts);\n        setTimeout(() => {\n          setFocusedItem(itemByIndex);\n          focusItem(itemByIndex);\n          onItemFocus(onItemFocusParams);\n        }, 300);\n      } else {\n        setFocusedItem(itemByIndex);\n        focusItem(itemByIndex);\n        onItemFocus(onItemFocusParams);\n      }\n    },\n    [visibleItems, scrollToIndex, setFocusedItem, onItemFocus],\n  );\n\n  return actions;\n};\n"],
+  "mappings": "AAAA;ACAA;AACA;AACA;AASO,MAAM,wBAAwB,CAAC,EAAE,WAAoC,QAAkC;AAC5G,QAAM;AAAA,IACJ,OAAO,EAAE;AAAA,IACT;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,MACE;AACJ,QAAM,EAAE,SAAS,aAAa,OAAqB;AACnD,QAAM,EAAE,kBAAkB,QAAQ,MAAM,oBAAoB,CAAC;AAC7D,QAAM,CAAC,eAAe,cAAc;AAEpC,YAAU,MAAM;AACd,QAAI,iBAAiB,SAAS,eAAe;AAC3C,eAAS,cAAc;AACvB,eAAS,gBAAgB;AACzB,iBAAW;AAAA;AAAA,KAEZ,CAAC,cAAc,eAAe;AAEjC,UAAQ,kBAAkB,YACxB,CAAC,aAAa;AACZ,UAAM,IAAI,IAAI,QAA4B,CAAC,YAAY;AACrD,eAAS,gBAAgB;AACzB,UAAI;AACF,8BAAsB,UAAU,UAAU,qBAAqB,sBAAsB;AAAA;AAEzF,eAAW;AACX,WAAO;AAAA,KAET,CAAC,UAAU,UAAU,qBAAqB,sBAAsB;AAElE,UAAQ,WAAW,YACjB,CAAC,MAAM,OAAO,EAAE,OAAO,cAAc;AACnC,QAAI;AAAe,oBAAc,MAAM;AAAA,KAEzC,CAAC;AAGH,UAAQ,gCAAgC,YACtC,CAAC,UAAU;AACT,UAAM,cAAc,aAAa;AACjC,oBAAgB;AAAA,KAElB,CAAC,cAAc;AAGjB,UAAQ,+BAA+B,YACrC,CAAC,OAAO,OAAO,EAAE,OAAO,SAAS,YAAY,YAAY;AACvD,UAAM,cAAc,aAAa;AACjC,UAAM,oBAAoB;AAAA,MACxB,WAAW,YAAY;AAAA,MACvB,cAAc,MAAM,cAAc,OAAO;AAAA,MACzC,MAAM;AAAA;AAGR,QAAI,KAAK,cAAc,eAAe;AACpC,oBAAc,OAAO;AACrB,iBAAW,MAAM;AACf,uBAAe;AACf,kBAAU;AACV,oBAAY;AAAA,SACX;AAAA,WACE;AACL,qBAAe;AACf,gBAAU;AACV,kBAAY;AAAA;AAAA,KAGhB,CAAC,cAAc,eAAe,gBAAgB;AAGhD,SAAO;AAAA;",
+  "names": []
+}

package/dist/esm/utils/useTree.js

@@ -0,0 +1,77 @@
+import * as React from "react";
+import { useState, useCallback, useMemo, useEffect } from "react";
+import TreeModel from "tree-model";
+import { cloneDeep } from "lodash";
+import { walkVisibles, enrichNodeModelInPlace, flattenTreeForDnD } from "./tree-helpers";
+import { updateExpandedState } from "./group-expands-helpers";
+const useTree = (data, props, states) => {
+  const { setExpandedGroups } = states;
+  const unfrozenData = useMemo(() => cloneDeep(data), [data]);
+  const tree = useMemo(() => new TreeModel(), []);
+  const [treeData, setTreeData] = useState({
+    id: "__ds_tree_root",
+    name: "__root",
+    isExpanded: true,
+    children: unfrozenData
+  });
+  useEffect(() => {
+    setTreeData({
+      id: "__ds_tree_root",
+      name: "__root",
+      isExpanded: true,
+      children: unfrozenData
+    });
+  }, [unfrozenData]);
+  const [rerenderItems, setRerenderItems] = useState({});
+  const triggerTreeRerender = useCallback(() => {
+    setRerenderItems({});
+  }, []);
+  const [treeRoot, setTreeRoot] = useState(tree.parse(treeData));
+  useEffect(() => {
+    setTreeRoot(tree.parse(treeData));
+  }, [treeData, rerenderItems, tree]);
+  const [visibleItems, setVisibleItems] = useState([]);
+  const { searchQuery, highlightOnlyQuery, onVisibleItemsChange, selection, expanded, onExpandChange } = props;
+  const updateUserExpandedState = useCallback(() => {
+    updateExpandedState(treeRoot, onExpandChange);
+  }, [treeRoot, onExpandChange]);
+  useEffect(() => {
+    const parsedVisibleItems = [];
+    const newExpandedHashMap = {};
+    const shouldContinueWalking = true;
+    treeRoot.walk((node) => {
+      enrichNodeModelInPlace(node, searchQuery, selection, expanded);
+      if (node.model.id && node.model.isGroup && node.model.isExpanded)
+        newExpandedHashMap[node.model.id] = true;
+      return shouldContinueWalking;
+    });
+    walkVisibles(treeRoot, (node) => {
+      parsedVisibleItems.push({ ...node.model, node });
+    }, true, highlightOnlyQuery);
+    setVisibleItems(parsedVisibleItems);
+    onVisibleItemsChange(parsedVisibleItems);
+    setExpandedGroups(newExpandedHashMap);
+  }, [
+    treeRoot,
+    rerenderItems,
+    searchQuery,
+    highlightOnlyQuery,
+    selection,
+    expanded,
+    setExpandedGroups
+  ]);
+  const flattenedItems = useMemo(() => flattenTreeForDnD(data), [data]);
+  return {
+    visibleItems,
+    flattenedItems,
+    tree,
+    treeRoot,
+    rerenderItems,
+    triggerTreeRerender,
+    updateUserExpandedState
+  };
+};
+export {
+  useTree
+};
+//# sourceMappingURL=useTree.js.map

package/dist/esm/utils/useTree.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/utils/useTree.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import { useState, useCallback, useMemo, useEffect } from 'react';\nimport TreeModel from 'tree-model';\nimport { cloneDeep } from 'lodash';\n\nimport { walkVisibles, enrichNodeModelInPlace, flattenTreeForDnD } from './tree-helpers';\nimport type { DSTreeviewT } from '../react-desc-prop-types';\nimport type { DSTreeviewInternalsT } from '../sharedTypes';\nimport { updateExpandedState } from './group-expands-helpers';\n\nexport const useTree = (\n  data: DSTreeviewT.SimpleItem[],\n  props: DSTreeviewT.Props,\n  states: {\n    setExpandedGroups: DSTreeviewInternalsT.StateSetter<DSTreeviewT.ExpandedItems>;\n  },\n) => {\n  const { setExpandedGroups } = states;\n  const unfrozenData = useMemo(() => cloneDeep(data), [data]);\n\n  // convert data into a TreeModel with extra isExpanded prop\n  // root element type is an exception, children model is based on what the dev passed on\n  // since root is an excepcion we must typecast\n  const tree = useMemo(() => new TreeModel(), []);\n  const [treeData, setTreeData] = useState({\n    id: '__ds_tree_root',\n    name: '__root',\n    isExpanded: true,\n    children: unfrozenData,\n  } as unknown as DSTreeviewT.Item);\n\n  useEffect(() => {\n    setTreeData({\n      id: '__ds_tree_root',\n      name: '__root',\n      isExpanded: true,\n      children: unfrozenData,\n    } as unknown as DSTreeviewT.Item);\n  }, [unfrozenData]);\n\n  // expose a way to rerender the tree\n  //   used for expand functionality\n  const [rerenderItems, setRerenderItems] = useState({});\n  const triggerTreeRerender = useCallback(() => {\n    setRerenderItems({});\n  }, []);\n\n  // when re-rendering we re-parse the list\n  const [treeRoot, setTreeRoot] = useState(tree.parse(treeData));\n  useEffect(() => {\n    setTreeRoot(tree.parse(treeData));\n  }, [treeData, rerenderItems, tree]);\n\n  const [visibleItems, setVisibleItems] = useState<DSTreeviewT.Item[]>([]);\n\n  const { searchQuery, highlightOnlyQuery, onVisibleItemsChange, selection, expanded, onExpandChange } = props;\n\n  const updateUserExpandedState = useCallback(() => {\n    updateExpandedState(treeRoot, onExpandChange);\n  }, [treeRoot, onExpandChange]);\n  // we add missing properties to the received Items\n  //   not the best of the patterns, but it works\n  //   this is where we convert \"SimpleItems\" to \"Items\"\n  //   this was done to avoid breaking changes back in v1\n  useEffect(() => {\n    const parsedVisibleItems: DSTreeviewT.Item[] = [];\n    const newExpandedHashMap: DSTreeviewT.ExpandedItems = {};\n    const shouldContinueWalking = true; // tree-model ask we return true if we want to continue walking\n    treeRoot.walk((node) => {\n      enrichNodeModelInPlace(node, searchQuery, selection, expanded);\n      if (node.model.id && node.model.isGroup && node.model.isExpanded) newExpandedHashMap[node.model.id] = true;\n      return shouldContinueWalking;\n    });\n\n    walkVisibles(\n      treeRoot,\n      (node) => {\n        parsedVisibleItems.push({ ...node.model, node });\n      },\n      true,\n      highlightOnlyQuery,\n    );\n    setVisibleItems(parsedVisibleItems);\n    onVisibleItemsChange(parsedVisibleItems);\n\n    setExpandedGroups(newExpandedHashMap);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [\n    treeRoot,\n    rerenderItems,\n    searchQuery,\n    highlightOnlyQuery,\n    selection,\n    expanded,\n    setExpandedGroups,\n    // onVisibleItemsChange // evaluate potential performance hit?\n  ]);\n\n  const flattenedItems = useMemo(() => flattenTreeForDnD(data), [data]);\n\n  return {\n    visibleItems,\n    flattenedItems,\n    tree,\n    treeRoot,\n    rerenderItems,\n    triggerTreeRerender,\n    updateUserExpandedState,\n  };\n};\n"],
+  "mappings": "AAAA;ACAA;AACA;AACA;AAEA;AAGA;AAEO,MAAM,UAAU,CACrB,MACA,OACA,WAGG;AACH,QAAM,EAAE,sBAAsB;AAC9B,QAAM,eAAe,QAAQ,MAAM,UAAU,OAAO,CAAC;AAKrD,QAAM,OAAO,QAAQ,MAAM,IAAI,aAAa;AAC5C,QAAM,CAAC,UAAU,eAAe,SAAS;AAAA,IACvC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,YAAY;AAAA,IACZ,UAAU;AAAA;AAGZ,YAAU,MAAM;AACd,gBAAY;AAAA,MACV,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,YAAY;AAAA,MACZ,UAAU;AAAA;AAAA,KAEX,CAAC;AAIJ,QAAM,CAAC,eAAe,oBAAoB,SAAS;AACnD,QAAM,sBAAsB,YAAY,MAAM;AAC5C,qBAAiB;AAAA,KAChB;AAGH,QAAM,CAAC,UAAU,eAAe,SAAS,KAAK,MAAM;AACpD,YAAU,MAAM;AACd,gBAAY,KAAK,MAAM;AAAA,KACtB,CAAC,UAAU,eAAe;AAE7B,QAAM,CAAC,cAAc,mBAAmB,SAA6B;AAErE,QAAM,EAAE,aAAa,oBAAoB,sBAAsB,WAAW,UAAU,mBAAmB;AAEvG,QAAM,0BAA0B,YAAY,MAAM;AAChD,wBAAoB,UAAU;AAAA,KAC7B,CAAC,UAAU;AAKd,YAAU,MAAM;AACd,UAAM,qBAAyC;AAC/C,UAAM,qBAAgD;AACtD,UAAM,wBAAwB;AAC9B,aAAS,KAAK,CAAC,SAAS;AACtB,6BAAuB,MAAM,aAAa,WAAW;AACrD,UAAI,KAAK,MAAM,MAAM,KAAK,MAAM,WAAW,KAAK,MAAM;AAAY,2BAAmB,KAAK,MAAM,MAAM;AACtG,aAAO;AAAA;AAGT,iBACE,UACA,CAAC,SAAS;AACR,yBAAmB,KAAK,KAAK,KAAK,OAAO;AAAA,OAE3C,MACA;AAEF,oBAAgB;AAChB,yBAAqB;AAErB,sBAAkB;AAAA,KAEjB;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAIF,QAAM,iBAAiB,QAAQ,MAAM,kBAAkB,OAAO,CAAC;AAE/D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA;",
+  "names": []
+}