@salt-ds/lab 1.0.0-alpha.8 → 1.0.0-alpha.81

package/dist-cjs/common-hooks/useCollectionItems.js

@@ -0,0 +1,285 @@
+'use strict';
+
+var react = require('react');
+var collectionProvider = require('./collectionProvider.js');
+var itemToString = require('./itemToString.js');
+var collectionItemUtils = require('./utils/collection-item-utils.js');
+var filterUtils = require('./utils/filter-utils.js');
+
+const defaultCollectionOptions = {};
+const useCollectionItems = ({
+  children,
+  id: idRoot,
+  label: _label = "",
+  options = defaultCollectionOptions,
+  // revealSelected = false,
+  source
+}) => {
+  const { getItemId } = options;
+  const [, forceUpdate] = react.useState(null);
+  const inheritedCollectionHook = collectionProvider.useCollection();
+  const dataRef = react.useRef([]);
+  const flattenedDataRef = react.useRef([]);
+  const EMPTY_COLLECTION = react.useMemo(() => [], []);
+  const filterPattern = react.useRef(options.filterPattern ?? "");
+  const {
+    getFilterRegex = filterUtils.getDefaultFilterRegex,
+    noChildrenLabel,
+    itemToString: itemToString$1 = itemToString.itemToString
+  } = options;
+  const isExpanded = react.useCallback(() => {
+    return options.defaultExpanded || false;
+  }, [options.defaultExpanded]);
+  const addMetadataToItems = react.useCallback(
+    (items, indexer, level = 1, path = "", results = [], flattenedCollection2 = [], flattenedSource2 = []) => {
+      items.forEach((item, i, all) => {
+        const isCollapsibleHeader = item.header && options.collapsibleHeaders;
+        const isNonCollapsibleGroupNode = item.childNodes && options.collapsibleHeaders === false;
+        const isLeaf = !item.childNodes || item.childNodes.length === 0;
+        const nonCollapsible = isNonCollapsibleGroupNode || isLeaf && !isCollapsibleHeader;
+        const childPath = path ? `${path}.${i}` : `item-${i}`;
+        const id = item.id ?? (getItemId ? getItemId(i) : `${idRoot}-${childPath}`);
+        const expanded = nonCollapsible ? void 0 : item.expanded ?? isExpanded();
+        const normalisedItem = {
+          ...item,
+          childNodes: void 0,
+          count: !isNonCollapsibleGroupNode && expanded === void 0 ? 0 : collectionItemUtils.countChildItems(item, all, i),
+          description: item.description,
+          disabled: collectionItemUtils.isDisabled(item.value),
+          focusable: collectionItemUtils.isFocusable(item.value) ? void 0 : false,
+          id,
+          index: indexer.value,
+          expanded,
+          level
+        };
+        results.push(normalisedItem);
+        flattenedCollection2.push(normalisedItem);
+        flattenedSource2.push(items[i].value);
+        indexer.value += 1;
+        if (item.childNodes) {
+          const [children2] = addMetadataToItems(
+            item.childNodes,
+            indexer,
+            level + 1,
+            childPath,
+            [],
+            flattenedCollection2,
+            flattenedSource2
+          );
+          normalisedItem.childNodes = children2;
+        }
+      });
+      return [results, flattenedSource2, flattenedCollection2];
+    },
+    [options.collapsibleHeaders, getItemId, idRoot, isExpanded]
+  );
+  const getFilter = react.useCallback(() => {
+    if (filterPattern.current) {
+      return filterUtils.getDefaultFilter(filterPattern.current, getFilterRegex);
+    }
+    return null;
+  }, [getFilterRegex]);
+  const collectVisibleItems = react.useCallback(
+    (items, filter = getFilter(), results = [], idx = { value: 0 }) => {
+      let skipToNextHeader = false;
+      for (const item of items) {
+        if (!(skipToNextHeader && !collectionItemUtils.isHeader(item))) {
+          if (item.value !== null && (filter === null || filter(itemToString$1(item.value)))) {
+            results[idx.value] = item;
+            idx.value += 1;
+          }
+          skipToNextHeader = false;
+          if (collectionItemUtils.isHeader(item) && item.expanded === false) {
+            skipToNextHeader = true;
+          } else if (collectionItemUtils.isGroupNode(item)) {
+            if (item.expanded !== false && item.childNodes) {
+              collectVisibleItems(item.childNodes, filter, results, idx);
+            }
+          }
+        }
+      }
+      return results;
+    },
+    [getFilter, itemToString$1]
+  );
+  const partialCollectionItems = react.useMemo(() => {
+    return inheritedCollectionHook ? EMPTY_COLLECTION : collectionItemUtils.sourceItems(source, { itemToString: itemToString$1, noChildrenLabel }) || collectionItemUtils.childItems(children) || [];
+  }, [
+    inheritedCollectionHook,
+    EMPTY_COLLECTION,
+    source,
+    itemToString$1,
+    noChildrenLabel,
+    children
+  ]);
+  const [collectionItems, flattenedSource, flattenedCollection] = react.useMemo(
+    () => inheritedCollectionHook ? [EMPTY_COLLECTION, EMPTY_COLLECTION, EMPTY_COLLECTION] : (
+      //@ts-ignore
+      addMetadataToItems(partialCollectionItems, { value: 0 })
+    ),
+    [
+      EMPTY_COLLECTION,
+      addMetadataToItems,
+      inheritedCollectionHook,
+      partialCollectionItems
+    ]
+  );
+  flattenedDataRef.current = flattenedCollection;
+  react.useMemo(
+    () => inheritedCollectionHook ? EMPTY_COLLECTION : dataRef.current = collectVisibleItems(collectionItems),
+    [
+      EMPTY_COLLECTION,
+      collectVisibleItems,
+      collectionItems,
+      inheritedCollectionHook
+    ]
+  );
+  const collectionItemsRef = react.useRef(collectionItems);
+  const setFilterPattern = react.useCallback(
+    (pattern = "") => {
+      if (typeof pattern === "string") {
+        filterPattern.current = pattern;
+        dataRef.current = collectVisibleItems(collectionItems);
+        forceUpdate({});
+      }
+    },
+    [collectionItems, collectVisibleItems]
+  );
+  const itemById = react.useCallback(
+    (id, target = collectionItems) => {
+      const sourceWithId = target.find(
+        (i) => {
+          var _a;
+          return i.id === id || ((_a = i == null ? void 0 : i.childNodes) == null ? void 0 : _a.length) && collectionItemUtils.isParentPath(i.id, id);
+        }
+      );
+      if ((sourceWithId == null ? void 0 : sourceWithId.id) === id && sourceWithId.index != null) {
+        return flattenedSource == null ? void 0 : flattenedSource[sourceWithId.index];
+      }
+      if (sourceWithId) {
+        return itemById(id, sourceWithId.childNodes);
+      }
+      throw Error(`useCollectionData itemById, id ${id} not found `);
+    },
+    [flattenedSource, collectionItems]
+  );
+  const toCollectionItem = react.useCallback(
+    (item) => {
+      const collectionItem = flattenedDataRef.current.find(
+        (i) => (
+          // const collectionItem = collectionItemsRef.current.find((i) =>
+          react.isValidElement(i.value) ? i.label === item : i.value === item
+        )
+      );
+      if (collectionItem) {
+        return collectionItem;
+      }
+      throw Error("useCollectionData toCollectionItem, item not found ");
+    },
+    []
+  );
+  const itemToCollectionItem = react.useCallback(
+    (sel) => {
+      if (sel === null) {
+        return null;
+      }
+      if (Array.isArray(sel)) {
+        const result = [];
+        for (const item of sel) {
+          const collectionItem = toCollectionItem(item);
+          result.push(collectionItem);
+        }
+        return result;
+      }
+      if (sel !== void 0) {
+        return toCollectionItem(sel);
+      }
+      return void 0;
+    },
+    [toCollectionItem]
+  );
+  const stringToCollectionItem = react.useCallback(
+    (value) => {
+      const toCollectionItem2 = (item) => {
+        const collectionItem = flattenedDataRef.current.find(
+          (i) => (
+            // const collectionItem = collectionItemsRef.current.find((i) =>
+            react.isValidElement(i.value) ? i.label === item : i.value !== null && itemToString$1(i.value) === item
+          )
+        );
+        if (collectionItem) {
+          return collectionItem;
+        }
+      };
+      if (value === null) {
+        return null;
+      }
+      if (Array.isArray(value)) {
+        const result = [];
+        for (const item of value) {
+          const collectionItem = toCollectionItem2(item);
+          if (collectionItem) {
+            result.push(collectionItem);
+          }
+        }
+        return result;
+      }
+      if (value !== void 0) {
+        return toCollectionItem2(value);
+      }
+      return void 0;
+    },
+    [itemToString$1]
+  );
+  const itemToId = react.useCallback((item) => {
+    for (const collectionItem of collectionItemsRef.current) {
+      if (item === collectionItem.value) {
+        return collectionItem.id;
+      }
+    }
+    throw Error("useCollectionData itemToId, item not found");
+  }, []);
+  const collapseGroupItem = react.useCallback(
+    (item) => {
+      collectionItemsRef.current = collectionItemUtils.replaceCollectionItem(
+        collectionItemsRef.current,
+        item.id,
+        {
+          expanded: false
+        }
+      );
+      dataRef.current = collectVisibleItems(collectionItemsRef.current);
+      forceUpdate({});
+    },
+    [collectVisibleItems]
+  );
+  const expandGroupItem = react.useCallback(
+    (item) => {
+      collectionItemsRef.current = collectionItemUtils.replaceCollectionItem(
+        collectionItemsRef.current,
+        item.id,
+        {
+          expanded: true
+        }
+      );
+      dataRef.current = collectVisibleItems(collectionItemsRef.current);
+      forceUpdate({});
+    },
+    [collectVisibleItems]
+  );
+  return inheritedCollectionHook || {
+    collapseGroupItem,
+    data: dataRef.current,
+    expandGroupItem,
+    // why not toggle, or just rely on setdata ?
+    setFilterPattern,
+    itemById,
+    itemToId,
+    toCollectionItem,
+    itemToCollectionItem,
+    stringToCollectionItem
+  };
+};
+
+exports.useCollectionItems = useCollectionItems;
+//# sourceMappingURL=useCollectionItems.js.map

package/dist-cjs/common-hooks/useCollectionItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCollectionItems.js","sources":["../src/common-hooks/useCollectionItems.ts"],"sourcesContent":["import { isValidElement, useCallback, useMemo, useRef, useState } from \"react\";\nimport { useCollection } from \"./collectionProvider\";\nimport type {\n  CollectionHookProps,\n  CollectionHookResult,\n  CollectionIndexer,\n  CollectionItem,\n} from \"./collectionTypes\";\nimport { itemToString as defaultItemToString } from \"./itemToString\";\nimport type {\n  SelectionStrategy,\n  SingleSelectionStrategy,\n} from \"./selectionTypes\";\nimport {\n  childItems,\n  countChildItems,\n  type FilterPredicate,\n  getDefaultFilter,\n  getDefaultFilterRegex,\n  isDisabled,\n  isFocusable,\n  isGroupNode,\n  isHeader,\n  isParentPath,\n  replaceCollectionItem,\n  sourceItems,\n} from \"./utils\";\n\nconst defaultCollectionOptions = {};\n\nexport const useCollectionItems = <Item>({\n  children,\n  id: idRoot,\n  label: _label = \"\",\n  options = defaultCollectionOptions,\n  // revealSelected = false,\n  source,\n}: CollectionHookProps<Item>): CollectionHookResult<Item> => {\n  const { getItemId } = options;\n\n  const [, forceUpdate] = useState<unknown>(null);\n  const inheritedCollectionHook = useCollection<Item>();\n  const dataRef = useRef<CollectionItem<Item>[]>([]);\n  const flattenedDataRef = useRef<CollectionItem<Item>[]>([]);\n  const EMPTY_COLLECTION: CollectionItem<Item>[] = useMemo(() => [], []);\n  const filterPattern = useRef<string>(options.filterPattern ?? \"\");\n\n  // destructure individual option values so we can safely reference them in dependency arrays\n  const {\n    getFilterRegex = getDefaultFilterRegex,\n    noChildrenLabel,\n    itemToString = defaultItemToString,\n  } = options;\n\n  const isExpanded = useCallback(() => {\n    // We can't do this here because itemToId won't work until we complete this phase\n    // if (Array.isArray(revealSelected)) {\n    //   const selectedIds = revealSelected.map(itemToId);\n    //   return selectedIds.some((id) => isParentPath(path, id));\n    // }\n    return options.defaultExpanded || false;\n  }, [options.defaultExpanded]);\n\n  const addMetadataToItems = useCallback(\n    <Item>(\n      items: CollectionItem<Item>[],\n      indexer: CollectionIndexer,\n      level = 1,\n      path = \"\",\n      results: CollectionItem<Item>[] = [],\n      flattenedCollection: CollectionItem<Item>[] = [],\n      flattenedSource: (Item | null)[] = [],\n    ): [CollectionItem<Item>[], (Item | null)[], CollectionItem<Item>[]] => {\n      items.forEach((item, i, all) => {\n        const isCollapsibleHeader = item.header && options.collapsibleHeaders;\n        const isNonCollapsibleGroupNode =\n          item.childNodes && options.collapsibleHeaders === false;\n        const isLeaf = !item.childNodes || item.childNodes.length === 0;\n        const nonCollapsible =\n          isNonCollapsibleGroupNode || (isLeaf && !isCollapsibleHeader);\n        const childPath = path ? `${path}.${i}` : `item-${i}`;\n        // getItemId is backward compatible with earlier List implementation.\n        // It is not appropriate for a nested source structure, where index\n        // will not always be an absolute offset.\n        const id =\n          item.id ?? (getItemId ? getItemId(i) : `${idRoot}-${childPath}`);\n\n        const expanded = nonCollapsible\n          ? undefined\n          : (item.expanded ?? isExpanded());\n        //TODO dev time check - if id is provided by user, make sure\n        // hierarchical pattern is consistent\n        const normalisedItem: CollectionItem<Item> = {\n          ...item,\n          childNodes: undefined,\n          count:\n            !isNonCollapsibleGroupNode && expanded === undefined\n              ? 0\n              : countChildItems(item, all, i),\n          description: item.description,\n          disabled: isDisabled(item.value),\n          focusable: isFocusable(item.value) ? undefined : false,\n          id,\n          index: indexer.value,\n          expanded,\n          level,\n        };\n        results.push(normalisedItem);\n        flattenedCollection.push(normalisedItem);\n        flattenedSource.push(items[i].value);\n\n        indexer.value += 1;\n\n        // if ((isNonCollapsibleGroupNode || expanded !== undefined) && !isCollapsibleHeader) {\n        if (item.childNodes) {\n          const [children] = addMetadataToItems<Item>(\n            item.childNodes,\n            indexer,\n            level + 1,\n            childPath,\n            [],\n            flattenedCollection,\n            flattenedSource,\n          );\n          normalisedItem.childNodes = children;\n        }\n      });\n      return [results, flattenedSource, flattenedCollection];\n    },\n    [options.collapsibleHeaders, getItemId, idRoot, isExpanded],\n  );\n\n  const getFilter = useCallback(() => {\n    if (filterPattern.current) {\n      return getDefaultFilter(filterPattern.current, getFilterRegex);\n    }\n    return null;\n  }, [getFilterRegex]);\n\n  const collectVisibleItems = useCallback(\n    (\n      items: CollectionItem<Item>[],\n      filter: null | FilterPredicate = getFilter(),\n      results: CollectionItem<Item>[] = [],\n      idx: { value: number } = { value: 0 },\n    ): CollectionItem<Item>[] => {\n      let skipToNextHeader = false;\n      for (const item of items) {\n        if (!(skipToNextHeader && !isHeader(item))) {\n          if (\n            item.value !== null &&\n            (filter === null || filter(itemToString(item.value)))\n          ) {\n            results[idx.value] = item;\n            idx.value += 1;\n          }\n          skipToNextHeader = false;\n          if (isHeader(item) && item.expanded === false) {\n            skipToNextHeader = true;\n          } else if (isGroupNode(item)) {\n            if (item.expanded !== false && item.childNodes) {\n              collectVisibleItems(item.childNodes, filter, results, idx);\n            }\n          }\n        }\n      }\n      return results;\n    },\n    [getFilter, itemToString],\n  );\n\n  // Stage 1 - convert source or children to CollectionItems.\n  const partialCollectionItems = useMemo(() => {\n    return inheritedCollectionHook\n      ? EMPTY_COLLECTION\n      : sourceItems<Item>(source, { itemToString, noChildrenLabel }) ||\n          childItems(children) ||\n          [];\n  }, [\n    inheritedCollectionHook,\n    EMPTY_COLLECTION,\n    source,\n    itemToString,\n    noChildrenLabel,\n    children,\n  ]);\n\n  // Stage 2 - extend the collectionItems with additional metadata\n  const [collectionItems, flattenedSource, flattenedCollection] = useMemo(\n    () =>\n      inheritedCollectionHook\n        ? [EMPTY_COLLECTION, EMPTY_COLLECTION, EMPTY_COLLECTION]\n        : //@ts-ignore\n          addMetadataToItems<Item>(partialCollectionItems, { value: 0 }),\n    [\n      EMPTY_COLLECTION,\n      addMetadataToItems,\n      inheritedCollectionHook,\n      partialCollectionItems,\n    ],\n  );\n  flattenedDataRef.current = flattenedCollection;\n\n  // Stage 3 prepare the list of visible items, this is what will be rendered\n  useMemo(\n    () =>\n      inheritedCollectionHook\n        ? EMPTY_COLLECTION\n        : (dataRef.current = collectVisibleItems(collectionItems)),\n    [\n      EMPTY_COLLECTION,\n      collectVisibleItems,\n      collectionItems,\n      inheritedCollectionHook,\n    ],\n  );\n\n  const collectionItemsRef = useRef(collectionItems);\n\n  const setFilterPattern = useCallback(\n    (pattern = \"\") => {\n      if (typeof pattern === \"string\") {\n        filterPattern.current = pattern;\n        dataRef.current = collectVisibleItems(collectionItems);\n        forceUpdate({});\n      }\n    },\n    [collectionItems, collectVisibleItems],\n  );\n\n  const itemById = useCallback(\n    (\n      id: string,\n      target: CollectionItem<Item>[] = collectionItems,\n    ): Item | never => {\n      const sourceWithId = target.find(\n        (i) => i.id === id || (i?.childNodes?.length && isParentPath(i.id, id)),\n      );\n      if (sourceWithId?.id === id && sourceWithId.index != null) {\n        //TODO do we need the flattered source at all ?\n        return flattenedSource?.[sourceWithId.index] as Item;\n      }\n      if (sourceWithId) {\n        return itemById(id, sourceWithId.childNodes);\n      }\n      throw Error(`useCollectionData itemById, id ${id} not found `);\n    },\n    [flattenedSource, collectionItems],\n  );\n\n  const toCollectionItem = useCallback(\n    (item: Item): CollectionItem<Item> | never => {\n      // TODO what about Tree structures, we need to search flattened source\n      const collectionItem = flattenedDataRef.current.find((i) =>\n        // const collectionItem = collectionItemsRef.current.find((i) =>\n        isValidElement(i.value) ? i.label === item : i.value === item,\n      );\n      if (collectionItem) {\n        return collectionItem;\n      }\n      throw Error(\"useCollectionData toCollectionItem, item not found \");\n    },\n    [],\n  );\n\n  // TODO types need more work, these are correct but we\n  // don't really want references to Selection in here\n  const itemToCollectionItem = useCallback(\n    <\n      Selection extends SelectionStrategy,\n      U extends Item | Item[] | null | undefined,\n    >(\n      sel: U,\n    ): Selection extends SingleSelectionStrategy\n      ? CollectionItem<Item> | null\n      : CollectionItem<Item>[] => {\n      type returnType = Selection extends SingleSelectionStrategy\n        ? CollectionItem<Item> | null\n        : CollectionItem<Item>[];\n\n      if (sel === null) {\n        return null as returnType;\n      }\n      if (Array.isArray(sel)) {\n        const result: CollectionItem<Item>[] = [];\n        for (const item of sel) {\n          const collectionItem = toCollectionItem(item);\n          result.push(collectionItem);\n        }\n        return result as returnType;\n      }\n      if (sel !== undefined) {\n        return toCollectionItem(sel as Item) as returnType;\n      }\n\n      return undefined as unknown as returnType;\n    },\n    [toCollectionItem],\n  );\n\n  const stringToCollectionItem = useCallback(\n    <Selection extends SelectionStrategy>(\n      value: string | null | undefined,\n    ): Selection extends SingleSelectionStrategy\n      ? CollectionItem<Item> | null\n      : CollectionItem<Item>[] => {\n      type returnType = Selection extends SingleSelectionStrategy\n        ? CollectionItem<Item> | null\n        : CollectionItem<Item>[];\n\n      const toCollectionItem = (\n        item: string,\n      ): undefined | CollectionItem<Item> | never => {\n        // TODO what about Tree structures, we need to search flattened source\n        const collectionItem = flattenedDataRef.current.find((i) =>\n          // const collectionItem = collectionItemsRef.current.find((i) =>\n          isValidElement(i.value)\n            ? i.label === item\n            : i.value !== null && itemToString(i.value) === item,\n        );\n        if (collectionItem) {\n          return collectionItem;\n        }\n      };\n\n      if (value === null) {\n        return null as returnType;\n      }\n      if (Array.isArray(value)) {\n        const result: CollectionItem<Item>[] = [];\n        for (const item of value) {\n          const collectionItem = toCollectionItem(item);\n          if (collectionItem) {\n            result.push(collectionItem);\n          }\n        }\n        return result as returnType;\n      }\n      if (value !== undefined) {\n        return toCollectionItem(value) as returnType;\n      }\n\n      return undefined as unknown as returnType;\n    },\n    [itemToString],\n  );\n\n  const itemToId = useCallback((item: Item): string => {\n    for (const collectionItem of collectionItemsRef.current) {\n      if (item === collectionItem.value) {\n        return collectionItem.id;\n      }\n    }\n    throw Error(\"useCollectionData itemToId, item not found\");\n  }, []);\n\n  const collapseGroupItem = useCallback(\n    (item: CollectionItem<Item>) => {\n      collectionItemsRef.current = replaceCollectionItem(\n        collectionItemsRef.current,\n        item.id,\n        {\n          expanded: false,\n        },\n      );\n      dataRef.current = collectVisibleItems(collectionItemsRef.current);\n      forceUpdate({});\n    },\n    [collectVisibleItems],\n  );\n\n  const expandGroupItem = useCallback(\n    (item: CollectionItem<Item>) => {\n      collectionItemsRef.current = replaceCollectionItem<Item>(\n        collectionItemsRef.current,\n        item.id,\n        {\n          expanded: true,\n        },\n      );\n      dataRef.current = collectVisibleItems(collectionItemsRef.current);\n      forceUpdate({});\n    },\n    [collectVisibleItems],\n  );\n\n  return (\n    inheritedCollectionHook || {\n      collapseGroupItem,\n      data: dataRef.current,\n      expandGroupItem, // why not toggle, or just rely on setdata ?\n      setFilterPattern,\n      itemById,\n      itemToId,\n      toCollectionItem,\n      itemToCollectionItem,\n      stringToCollectionItem,\n    }\n  );\n};\n"],"names":["useState","useCollection","useRef","useMemo","getDefaultFilterRegex","itemToString","defaultItemToString","useCallback","flattenedCollection","flattenedSource","countChildItems","isDisabled","isFocusable","children","getDefaultFilter","isHeader","isGroupNode","sourceItems","childItems","isParentPath","isValidElement","toCollectionItem","replaceCollectionItem"],"mappings":";;;;;;;;AA4BA,MAAM,2BAA2B,EAAC;AAE3B,MAAM,qBAAqB,CAAO;AAAA,EACvC,QAAA;AAAA,EACA,EAAA,EAAI,MAAA;AAAA,EACJ,OAAO,MAAA,GAAS,EAAA;AAAA,EAChB,OAAA,GAAU,wBAAA;AAAA;AAAA,EAEV;AACF,CAAA,KAA6D;AAC3D,EAAA,MAAM,EAAE,WAAU,GAAI,OAAA;AAEtB,EAAA,MAAM,GAAG,WAAW,CAAA,GAAIA,eAAkB,IAAI,CAAA;AAC9C,EAAA,MAAM,0BAA0BC,gCAAA,EAAoB;AACpD,EAAA,MAAM,OAAA,GAAUC,YAAA,CAA+B,EAAE,CAAA;AACjD,EAAA,MAAM,gBAAA,GAAmBA,YAAA,CAA+B,EAAE,CAAA;AAC1D,EAAA,MAAM,mBAA2CC,aAAA,CAAQ,MAAM,EAAC,EAAG,EAAE,CAAA;AACrE,EAAA,MAAM,aAAA,GAAgBD,YAAA,CAAe,OAAA,CAAQ,aAAA,IAAiB,EAAE,CAAA;AAGhE,EAAA,MAAM;AAAA,IACJ,cAAA,GAAiBE,iCAAA;AAAA,IACjB,eAAA;AAAA,kBACAC,cAAA,GAAeC;AAAA,GACjB,GAAI,OAAA;AAEJ,EAAA,MAAM,UAAA,GAAaC,kBAAY,MAAM;AAMnC,IAAA,OAAO,QAAQ,eAAA,IAAmB,KAAA;AAAA,EACpC,CAAA,EAAG,CAAC,OAAA,CAAQ,eAAe,CAAC,CAAA;AAE5B,EAAA,MAAM,kBAAA,GAAqBA,iBAAA;AAAA,IACzB,CACE,KAAA,EACA,OAAA,EACA,KAAA,GAAQ,GACR,IAAA,GAAO,EAAA,EACP,OAAA,GAAkC,IAClCC,oBAAAA,GAA8C,EAAC,EAC/CC,gBAAAA,GAAmC,EAAC,KACkC;AACtE,MAAA,KAAA,CAAM,OAAA,CAAQ,CAAC,IAAA,EAAM,CAAA,EAAG,GAAA,KAAQ;AAC9B,QAAA,MAAM,mBAAA,GAAsB,IAAA,CAAK,MAAA,IAAU,OAAA,CAAQ,kBAAA;AACnD,QAAA,MAAM,yBAAA,GACJ,IAAA,CAAK,UAAA,IAAc,OAAA,CAAQ,kBAAA,KAAuB,KAAA;AACpD,QAAA,MAAM,SAAS,CAAC,IAAA,CAAK,UAAA,IAAc,IAAA,CAAK,WAAW,MAAA,KAAW,CAAA;AAC9D,QAAA,MAAM,cAAA,GACJ,yBAAA,IAA8B,MAAA,IAAU,CAAC,mBAAA;AAC3C,QAAA,MAAM,SAAA,GAAY,OAAO,CAAA,EAAG,IAAI,IAAI,CAAC,CAAA,CAAA,GAAK,QAAQ,CAAC,CAAA,CAAA;AAInD,QAAA,MAAM,EAAA,GACJ,IAAA,CAAK,EAAA,KAAO,SAAA,GAAY,SAAA,CAAU,CAAC,CAAA,GAAI,CAAA,EAAG,MAAM,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA,CAAA;AAE/D,QAAA,MAAM,QAAA,GAAW,cAAA,GACb,MAAA,GACC,IAAA,CAAK,YAAY,UAAA,EAAW;AAGjC,QAAA,MAAM,cAAA,GAAuC;AAAA,UAC3C,GAAG,IAAA;AAAA,UACH,UAAA,EAAY,MAAA;AAAA,UACZ,KAAA,EACE,CAAC,yBAAA,IAA6B,QAAA,KAAa,SACvC,CAAA,GACAC,mCAAA,CAAgB,IAAA,EAAM,GAAA,EAAK,CAAC,CAAA;AAAA,UAClC,aAAa,IAAA,CAAK,WAAA;AAAA,UAClB,QAAA,EAAUC,8BAAA,CAAW,IAAA,CAAK,KAAK,CAAA;AAAA,UAC/B,SAAA,EAAWC,+BAAA,CAAY,IAAA,CAAK,KAAK,IAAI,MAAA,GAAY,KAAA;AAAA,UACjD,EAAA;AAAA,UACA,OAAO,OAAA,CAAQ,KAAA;AAAA,UACf,QAAA;AAAA,UACA;AAAA,SACF;AACA,QAAA,OAAA,CAAQ,KAAK,cAAc,CAAA;AAC3B,QAAAJ,oBAAAA,CAAoB,KAAK,cAAc,CAAA;AACvC,QAAAC,gBAAAA,CAAgB,IAAA,CAAK,KAAA,CAAM,CAAC,EAAE,KAAK,CAAA;AAEnC,QAAA,OAAA,CAAQ,KAAA,IAAS,CAAA;AAGjB,QAAA,IAAI,KAAK,UAAA,EAAY;AACnB,UAAA,MAAM,CAACI,SAAQ,CAAA,GAAI,kBAAA;AAAA,YACjB,IAAA,CAAK,UAAA;AAAA,YACL,OAAA;AAAA,YACA,KAAA,GAAQ,CAAA;AAAA,YACR,SAAA;AAAA,YACA,EAAC;AAAA,YACDL,oBAAAA;AAAA,YACAC;AAAA,WACF;AACA,UAAA,cAAA,CAAe,UAAA,GAAaI,SAAAA;AAAA,QAC9B;AAAA,MACF,CAAC,CAAA;AACD,MAAA,OAAO,CAAC,OAAA,EAASJ,gBAAAA,EAAiBD,oBAAmB,CAAA;AAAA,IACvD,CAAA;AAAA,IACA,CAAC,OAAA,CAAQ,kBAAA,EAAoB,SAAA,EAAW,QAAQ,UAAU;AAAA,GAC5D;AAEA,EAAA,MAAM,SAAA,GAAYD,kBAAY,MAAM;AAClC,IAAA,IAAI,cAAc,OAAA,EAAS;AACzB,MAAA,OAAOO,4BAAA,CAAiB,aAAA,CAAc,OAAA,EAAS,cAAc,CAAA;AAAA,IAC/D;AACA,IAAA,OAAO,IAAA;AAAA,EACT,CAAA,EAAG,CAAC,cAAc,CAAC,CAAA;AAEnB,EAAA,MAAM,mBAAA,GAAsBP,iBAAA;AAAA,IAC1B,CACE,KAAA,EACA,MAAA,GAAiC,SAAA,EAAU,EAC3C,OAAA,GAAkC,EAAC,EACnC,GAAA,GAAyB,EAAE,KAAA,EAAO,CAAA,EAAE,KACT;AAC3B,MAAA,IAAI,gBAAA,GAAmB,KAAA;AACvB,MAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,QAAA,IAAI,EAAE,gBAAA,IAAoB,CAACQ,4BAAA,CAAS,IAAI,CAAA,CAAA,EAAI;AAC1C,UAAA,IACE,IAAA,CAAK,KAAA,KAAU,IAAA,KACd,MAAA,KAAW,IAAA,IAAQ,OAAOV,cAAA,CAAa,IAAA,CAAK,KAAK,CAAC,CAAA,CAAA,EACnD;AACA,YAAA,OAAA,CAAQ,GAAA,CAAI,KAAK,CAAA,GAAI,IAAA;AACrB,YAAA,GAAA,CAAI,KAAA,IAAS,CAAA;AAAA,UACf;AACA,UAAA,gBAAA,GAAmB,KAAA;AACnB,UAAA,IAAIU,4BAAA,CAAS,IAAI,CAAA,IAAK,IAAA,CAAK,aAAa,KAAA,EAAO;AAC7C,YAAA,gBAAA,GAAmB,IAAA;AAAA,UACrB,CAAA,MAAA,IAAWC,+BAAA,CAAY,IAAI,CAAA,EAAG;AAC5B,YAAA,IAAI,IAAA,CAAK,QAAA,KAAa,KAAA,IAAS,IAAA,CAAK,UAAA,EAAY;AAC9C,cAAA,mBAAA,CAAoB,IAAA,CAAK,UAAA,EAAY,MAAA,EAAQ,OAAA,EAAS,GAAG,CAAA;AAAA,YAC3D;AAAA,UACF;AAAA,QACF;AAAA,MACF;AACA,MAAA,OAAO,OAAA;AAAA,IACT,CAAA;AAAA,IACA,CAAC,WAAWX,cAAY;AAAA,GAC1B;AAGA,EAAA,MAAM,sBAAA,GAAyBF,cAAQ,MAAM;AAC3C,IAAA,OAAO,uBAAA,GACH,gBAAA,GACAc,+BAAA,CAAkB,MAAA,EAAQ,gBAAEZ,cAAA,EAAc,eAAA,EAAiB,CAAA,IACzDa,8BAAA,CAAW,QAAQ,CAAA,IACnB,EAAC;AAAA,EACT,CAAA,EAAG;AAAA,IACD,uBAAA;AAAA,IACA,gBAAA;AAAA,IACA,MAAA;AAAA,IACAb,cAAA;AAAA,IACA,eAAA;AAAA,IACA;AAAA,GACD,CAAA;AAGD,EAAA,MAAM,CAAC,eAAA,EAAiB,eAAA,EAAiB,mBAAmB,CAAA,GAAIF,aAAA;AAAA,IAC9D,MACE,uBAAA,GACI,CAAC,gBAAA,EAAkB,kBAAkB,gBAAgB,CAAA;AAAA;AAAA,MAErD,kBAAA,CAAyB,sBAAA,EAAwB,EAAE,KAAA,EAAO,GAAG;AAAA,KAAA;AAAA,IACnE;AAAA,MACE,gBAAA;AAAA,MACA,kBAAA;AAAA,MACA,uBAAA;AAAA,MACA;AAAA;AACF,GACF;AACA,EAAA,gBAAA,CAAiB,OAAA,GAAU,mBAAA;AAG3B,EAAAA,aAAA;AAAA,IACE,MACE,uBAAA,GACI,gBAAA,GACC,OAAA,CAAQ,OAAA,GAAU,oBAAoB,eAAe,CAAA;AAAA,IAC5D;AAAA,MACE,gBAAA;AAAA,MACA,mBAAA;AAAA,MACA,eAAA;AAAA,MACA;AAAA;AACF,GACF;AAEA,EAAA,MAAM,kBAAA,GAAqBD,aAAO,eAAe,CAAA;AAEjD,EAAA,MAAM,gBAAA,GAAmBK,iBAAA;AAAA,IACvB,CAAC,UAAU,EAAA,KAAO;AAChB,MAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAC/B,QAAA,aAAA,CAAc,OAAA,GAAU,OAAA;AACxB,QAAA,OAAA,CAAQ,OAAA,GAAU,oBAAoB,eAAe,CAAA;AACrD,QAAA,WAAA,CAAY,EAAE,CAAA;AAAA,MAChB;AAAA,IACF,CAAA;AAAA,IACA,CAAC,iBAAiB,mBAAmB;AAAA,GACvC;AAEA,EAAA,MAAM,QAAA,GAAWA,iBAAA;AAAA,IACf,CACE,EAAA,EACA,MAAA,GAAiC,eAAA,KAChB;AACjB,MAAA,MAAM,eAAe,MAAA,CAAO,IAAA;AAAA,QAC1B,CAAC,CAAA,KAAG;AA5OZ,UAAA,IAAA,EAAA;AA4Oe,UAAA,OAAA,CAAA,CAAE,EAAA,KAAO,QAAO,EAAA,GAAA,CAAA,IAAA,IAAA,GAAA,MAAA,GAAA,CAAA,CAAG,UAAA,KAAH,mBAAe,MAAA,KAAUY,gCAAA,CAAa,CAAA,CAAE,EAAA,EAAI,EAAE,CAAA;AAAA,QAAA;AAAA,OACvE;AACA,MAAA,IAAA,CAAI,YAAA,IAAA,IAAA,GAAA,MAAA,GAAA,YAAA,CAAc,EAAA,MAAO,EAAA,IAAM,YAAA,CAAa,SAAS,IAAA,EAAM;AAEzD,QAAA,OAAO,mDAAkB,YAAA,CAAa,KAAA,CAAA;AAAA,MACxC;AACA,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,OAAO,QAAA,CAAS,EAAA,EAAI,YAAA,CAAa,UAAU,CAAA;AAAA,MAC7C;AACA,MAAA,MAAM,KAAA,CAAM,CAAA,+BAAA,EAAkC,EAAE,CAAA,WAAA,CAAa,CAAA;AAAA,IAC/D,CAAA;AAAA,IACA,CAAC,iBAAiB,eAAe;AAAA,GACnC;AAEA,EAAA,MAAM,gBAAA,GAAmBZ,iBAAA;AAAA,IACvB,CAAC,IAAA,KAA6C;AAE5C,MAAA,MAAM,cAAA,GAAiB,iBAAiB,OAAA,CAAQ,IAAA;AAAA,QAAK,CAAC,CAAA;AAAA;AAAA,UAEpDa,oBAAA,CAAe,EAAE,KAAK,CAAA,GAAI,EAAE,KAAA,KAAU,IAAA,GAAO,EAAE,KAAA,KAAU;AAAA;AAAA,OAC3D;AACA,MAAA,IAAI,cAAA,EAAgB;AAClB,QAAA,OAAO,cAAA;AAAA,MACT;AACA,MAAA,MAAM,MAAM,qDAAqD,CAAA;AAAA,IACnE,CAAA;AAAA,IACA;AAAC,GACH;AAIA,EAAA,MAAM,oBAAA,GAAuBb,iBAAA;AAAA,IAC3B,CAIE,GAAA,KAG4B;AAK5B,MAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,QAAA,OAAO,IAAA;AAAA,MACT;AACA,MAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,GAAG,CAAA,EAAG;AACtB,QAAA,MAAM,SAAiC,EAAC;AACxC,QAAA,KAAA,MAAW,QAAQ,GAAA,EAAK;AACtB,UAAA,MAAM,cAAA,GAAiB,iBAAiB,IAAI,CAAA;AAC5C,UAAA,MAAA,CAAO,KAAK,cAAc,CAAA;AAAA,QAC5B;AACA,QAAA,OAAO,MAAA;AAAA,MACT;AACA,MAAA,IAAI,QAAQ,MAAA,EAAW;AACrB,QAAA,OAAO,iBAAiB,GAAW,CAAA;AAAA,MACrC;AAEA,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,IACA,CAAC,gBAAgB;AAAA,GACnB;AAEA,EAAA,MAAM,sBAAA,GAAyBA,iBAAA;AAAA,IAC7B,CACE,KAAA,KAG4B;AAK5B,MAAA,MAAMc,iBAAAA,GAAmB,CACvB,IAAA,KAC6C;AAE7C,QAAA,MAAM,cAAA,GAAiB,iBAAiB,OAAA,CAAQ,IAAA;AAAA,UAAK,CAAC,CAAA;AAAA;AAAA,YAEpDD,oBAAA,CAAe,CAAA,CAAE,KAAK,CAAA,GAClB,CAAA,CAAE,KAAA,KAAU,IAAA,GACZ,CAAA,CAAE,KAAA,KAAU,IAAA,IAAQf,cAAA,CAAa,CAAA,CAAE,KAAK,CAAA,KAAM;AAAA;AAAA,SACpD;AACA,QAAA,IAAI,cAAA,EAAgB;AAClB,UAAA,OAAO,cAAA;AAAA,QACT;AAAA,MACF,CAAA;AAEA,MAAA,IAAI,UAAU,IAAA,EAAM;AAClB,QAAA,OAAO,IAAA;AAAA,MACT;AACA,MAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,QAAA,MAAM,SAAiC,EAAC;AACxC,QAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,UAAA,MAAM,cAAA,GAAiBgB,kBAAiB,IAAI,CAAA;AAC5C,UAAA,IAAI,cAAA,EAAgB;AAClB,YAAA,MAAA,CAAO,KAAK,cAAc,CAAA;AAAA,UAC5B;AAAA,QACF;AACA,QAAA,OAAO,MAAA;AAAA,MACT;AACA,MAAA,IAAI,UAAU,MAAA,EAAW;AACvB,QAAA,OAAOA,kBAAiB,KAAK,CAAA;AAAA,MAC/B;AAEA,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,IACA,CAAChB,cAAY;AAAA,GACf;AAEA,EAAA,MAAM,QAAA,GAAWE,iBAAA,CAAY,CAAC,IAAA,KAAuB;AACnD,IAAA,KAAA,MAAW,cAAA,IAAkB,mBAAmB,OAAA,EAAS;AACvD,MAAA,IAAI,IAAA,KAAS,eAAe,KAAA,EAAO;AACjC,QAAA,OAAO,cAAA,CAAe,EAAA;AAAA,MACxB;AAAA,IACF;AACA,IAAA,MAAM,MAAM,4CAA4C,CAAA;AAAA,EAC1D,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,MAAM,iBAAA,GAAoBA,iBAAA;AAAA,IACxB,CAAC,IAAA,KAA+B;AAC9B,MAAA,kBAAA,CAAmB,OAAA,GAAUe,yCAAA;AAAA,QAC3B,kBAAA,CAAmB,OAAA;AAAA,QACnB,IAAA,CAAK,EAAA;AAAA,QACL;AAAA,UACE,QAAA,EAAU;AAAA;AACZ,OACF;AACA,MAAA,OAAA,CAAQ,OAAA,GAAU,mBAAA,CAAoB,kBAAA,CAAmB,OAAO,CAAA;AAChE,MAAA,WAAA,CAAY,EAAE,CAAA;AAAA,IAChB,CAAA;AAAA,IACA,CAAC,mBAAmB;AAAA,GACtB;AAEA,EAAA,MAAM,eAAA,GAAkBf,iBAAA;AAAA,IACtB,CAAC,IAAA,KAA+B;AAC9B,MAAA,kBAAA,CAAmB,OAAA,GAAUe,yCAAA;AAAA,QAC3B,kBAAA,CAAmB,OAAA;AAAA,QACnB,IAAA,CAAK,EAAA;AAAA,QACL;AAAA,UACE,QAAA,EAAU;AAAA;AACZ,OACF;AACA,MAAA,OAAA,CAAQ,OAAA,GAAU,mBAAA,CAAoB,kBAAA,CAAmB,OAAO,CAAA;AAChE,MAAA,WAAA,CAAY,EAAE,CAAA;AAAA,IAChB,CAAA;AAAA,IACA,CAAC,mBAAmB;AAAA,GACtB;AAEA,EAAA,OACE,uBAAA,IAA2B;AAAA,IACzB,iBAAA;AAAA,IACA,MAAM,OAAA,CAAQ,OAAA;AAAA,IACd,eAAA;AAAA;AAAA,IACA,gBAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA,gBAAA;AAAA,IACA,oBAAA;AAAA,IACA;AAAA,GACF;AAEJ;;;;"}

package/dist-cjs/common-hooks/useImperativeScrollingAPI.js

@@ -0,0 +1,52 @@
+'use strict';
+
+var react = require('react');
+
+const noScrolling = {
+  scrollToIndex: () => void 0,
+  scrollToItem: () => void 0,
+  scrollTo: () => void 0
+};
+const useImperativeScrollingAPI = ({
+  collectionHook,
+  forwardedRef,
+  scrollableRef,
+  scrollIntoView
+}) => {
+  const scrollHandles = react.useMemo(
+    () => ({
+      scrollToIndex: (itemIndex) => {
+        const collectionItem = collectionHook.data[itemIndex];
+        if (collectionItem) {
+          scrollIntoView == null ? void 0 : scrollIntoView(collectionItem);
+        }
+      },
+      scrollToItem: (item) => {
+        const collectionItem = collectionHook.toCollectionItem(item);
+        if (collectionItem) {
+          scrollIntoView == null ? void 0 : scrollIntoView(collectionItem);
+        }
+      },
+      scrollTo: (scrollOffset) => {
+        if (scrollableRef == null ? void 0 : scrollableRef.current) {
+          scrollableRef.current.scrollTop = scrollOffset;
+        }
+      }
+    }),
+    [
+      collectionHook.data,
+      collectionHook.toCollectionItem,
+      scrollIntoView,
+      scrollableRef
+    ]
+  );
+  react.useImperativeHandle(forwardedRef, () => {
+    if (scrollableRef.current) {
+      return scrollHandles;
+    }
+    return noScrolling;
+  }, [scrollHandles, scrollableRef]);
+};
+
+exports.useImperativeScrollingAPI = useImperativeScrollingAPI;
+//# sourceMappingURL=useImperativeScrollingAPI.js.map

package/dist-cjs/common-hooks/useImperativeScrollingAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useImperativeScrollingAPI.js","sources":["../src/common-hooks/useImperativeScrollingAPI.ts"],"sourcesContent":["import {\n  type ForwardedRef,\n  type MutableRefObject,\n  useImperativeHandle,\n  useMemo,\n} from \"react\";\nimport type { CollectionHookResult, CollectionItem } from \"./collectionTypes\";\n\nexport interface ScrollingAPI<Item> {\n  scrollToIndex: (itemIndex: number) => void;\n  scrollToItem: (item: Item) => void;\n  scrollTo: (scrollOffset: number) => void;\n}\n\nexport interface ScrollingAPIHook<Item> {\n  collectionHook: CollectionHookResult<Item>;\n  forwardedRef?: ForwardedRef<ScrollingAPI<Item>>;\n  scrollableRef: MutableRefObject<HTMLElement | null>;\n  scrollIntoView?: (item: CollectionItem<Item>) => void;\n}\n\nconst noScrolling: ScrollingAPI<unknown> = {\n  scrollToIndex: () => undefined,\n  scrollToItem: () => undefined,\n  scrollTo: () => undefined,\n};\n\nexport const useImperativeScrollingAPI = <Item>({\n  collectionHook,\n  forwardedRef,\n  scrollableRef,\n  scrollIntoView,\n}: ScrollingAPIHook<Item>) => {\n  const scrollHandles: ScrollingAPI<Item> = useMemo(\n    () => ({\n      scrollToIndex: (itemIndex: number) => {\n        const collectionItem = collectionHook.data[itemIndex];\n        if (collectionItem) {\n          scrollIntoView?.(collectionItem);\n        }\n      },\n      scrollToItem: (item: Item) => {\n        const collectionItem = collectionHook.toCollectionItem(item);\n        if (collectionItem) {\n          scrollIntoView?.(collectionItem);\n        }\n      },\n      scrollTo: (scrollOffset: number) => {\n        if (scrollableRef?.current) {\n          scrollableRef.current.scrollTop = scrollOffset;\n        }\n      },\n    }),\n    [\n      collectionHook.data,\n      collectionHook.toCollectionItem,\n      scrollIntoView,\n      scrollableRef,\n    ],\n  );\n\n  useImperativeHandle(forwardedRef, () => {\n    if (scrollableRef.current) {\n      return scrollHandles;\n    }\n    return noScrolling;\n  }, [scrollHandles, scrollableRef]);\n};\n"],"names":["useMemo","useImperativeHandle"],"mappings":";;;;AAqBA,MAAM,WAAA,GAAqC;AAAA,EACzC,eAAe,MAAM,MAAA;AAAA,EACrB,cAAc,MAAM,MAAA;AAAA,EACpB,UAAU,MAAM;AAClB,CAAA;AAEO,MAAM,4BAA4B,CAAO;AAAA,EAC9C,cAAA;AAAA,EACA,YAAA;AAAA,EACA,aAAA;AAAA,EACA;AACF,CAAA,KAA8B;AAC5B,EAAA,MAAM,aAAA,GAAoCA,aAAA;AAAA,IACxC,OAAO;AAAA,MACL,aAAA,EAAe,CAAC,SAAA,KAAsB;AACpC,QAAA,MAAM,cAAA,GAAiB,cAAA,CAAe,IAAA,CAAK,SAAS,CAAA;AACpD,QAAA,IAAI,cAAA,EAAgB;AAClB,UAAA,cAAA,IAAA,IAAA,GAAA,MAAA,GAAA,cAAA,CAAiB,cAAA,CAAA;AAAA,QACnB;AAAA,MACF,CAAA;AAAA,MACA,YAAA,EAAc,CAAC,IAAA,KAAe;AAC5B,QAAA,MAAM,cAAA,GAAiB,cAAA,CAAe,gBAAA,CAAiB,IAAI,CAAA;AAC3D,QAAA,IAAI,cAAA,EAAgB;AAClB,UAAA,cAAA,IAAA,IAAA,GAAA,MAAA,GAAA,cAAA,CAAiB,cAAA,CAAA;AAAA,QACnB;AAAA,MACF,CAAA;AAAA,MACA,QAAA,EAAU,CAAC,YAAA,KAAyB;AAClC,QAAA,IAAI,+CAAe,OAAA,EAAS;AAC1B,UAAA,aAAA,CAAc,QAAQ,SAAA,GAAY,YAAA;AAAA,QACpC;AAAA,MACF;AAAA,KACF,CAAA;AAAA,IACA;AAAA,MACE,cAAA,CAAe,IAAA;AAAA,MACf,cAAA,CAAe,gBAAA;AAAA,MACf,cAAA;AAAA,MACA;AAAA;AACF,GACF;AAEA,EAAAC,yBAAA,CAAoB,cAAc,MAAM;AACtC,IAAA,IAAI,cAAc,OAAA,EAAS;AACzB,MAAA,OAAO,aAAA;AAAA,IACT;AACA,IAAA,OAAO,WAAA;AAAA,EACT,CAAA,EAAG,CAAC,aAAA,EAAe,aAAa,CAAC,CAAA;AACnC;;;;"}

package/dist-cjs/common-hooks/useKeyboardNavigation.js

@@ -0,0 +1,289 @@
+'use strict';
+
+var core = require('@salt-ds/core');
+var react = require('react');
+var keyUtils = require('./keyUtils.js');
+var selectionTypes = require('./selectionTypes.js');
+
+const LIST_FOCUS_VISIBLE = -2;
+function nextItemIdx(count, key, idx) {
+  if (key === keyUtils.ArrowUp || key === keyUtils.End) {
+    if (idx > 0) {
+      return idx - 1;
+    }
+    return idx;
+  }
+  if (idx === null) {
+    return 0;
+  }
+  if (idx === count - 1) {
+    return idx;
+  }
+  return idx + 1;
+}
+const getIndexOfSelectedItem = (items, selected) => {
+  const selectedItem = selectionTypes.getFirstSelectedItem(selected);
+  if (selectedItem) {
+    return items.indexOf(selectedItem);
+  }
+  return -1;
+};
+const getStartIdx = (key, idx, selectedIdx, length) => {
+  if (key === keyUtils.End) {
+    return length;
+  }
+  if (key === keyUtils.Home) {
+    return -1;
+  }
+  if (idx !== -1) {
+    return idx;
+  }
+  return selectedIdx;
+};
+const getItemRect = (item) => {
+  const el = document.getElementById(item.id);
+  if (el) {
+    return el.getBoundingClientRect();
+  }
+  throw Error(
+    `useKeyboardNavigation.getItemRect no element found for item  #${item == null ? void 0 : item.id}`
+  );
+};
+const pageDown = (containerEl, itemEl, indexPositions, index) => {
+  const { top: itemTop } = itemEl.getBoundingClientRect();
+  const { scrollTop, clientHeight, scrollHeight } = containerEl;
+  const lastIndexPosition = indexPositions.length - 1;
+  const newScrollTop = Math.min(
+    scrollTop + clientHeight,
+    scrollHeight - clientHeight
+  );
+  if (newScrollTop !== scrollTop && index < lastIndexPosition) {
+    containerEl.scrollTo(0, newScrollTop);
+    let nextIdx = index;
+    let nextRect;
+    do {
+      nextIdx += 1;
+      nextRect = getItemRect(indexPositions[nextIdx]);
+    } while (nextRect.top < itemTop && nextIdx < lastIndexPosition);
+    return nextIdx;
+  }
+};
+const pageUp = async (containerEl, itemEl, indexPositions, index) => {
+  const { top: itemTop } = itemEl.getBoundingClientRect();
+  const { scrollTop, clientHeight } = containerEl;
+  const newScrollTop = Math.max(scrollTop - clientHeight, 0);
+  if (newScrollTop !== scrollTop && index > 0) {
+    containerEl.scrollTo(0, newScrollTop);
+    return new Promise((resolve) => {
+      requestAnimationFrame(() => {
+        let nextIdx = index;
+        let nextRect;
+        do {
+          nextIdx -= 1;
+          nextRect = getItemRect(indexPositions[nextIdx]);
+        } while (nextRect.top > itemTop && nextIdx > 0);
+        resolve(nextIdx);
+      });
+    });
+  }
+};
+const isLeaf = (item) => !item.header && !item.childNodes;
+const isFocusable = (item) => isLeaf(item) || item.expanded !== void 0;
+const useKeyboardNavigation = ({
+  containerRef,
+  defaultHighlightedIndex = -1,
+  disableHighlightOnFocus,
+  highlightedIndex: highlightedIndexProp,
+  indexPositions,
+  onHighlight,
+  onKeyboardNavigation,
+  restoreLastFocus,
+  selected
+}) => {
+  const lastFocus = react.useRef(-1);
+  const [, forceRender] = react.useState({});
+  const [highlightedIndex, setHighlightedIdx, isControlledHighlighting] = core.useControlled({
+    controlled: highlightedIndexProp,
+    default: defaultHighlightedIndex,
+    name: "UseKeyboardNavigation"
+  });
+  const setHighlightedIndex = react.useCallback(
+    (idx, fromKeyboard = false) => {
+      onHighlight == null ? void 0 : onHighlight(idx);
+      setHighlightedIdx(idx);
+      if (fromKeyboard) {
+        lastFocus.current = idx;
+      }
+    },
+    [onHighlight]
+  );
+  const nextPageItemIdx = react.useCallback(
+    async (e, index) => {
+      const { id } = indexPositions[index];
+      let result;
+      if (id) {
+        const itemEl = document.getElementById(id);
+        const { current: containerEl } = containerRef;
+        if (itemEl && containerEl) {
+          result = e.key === keyUtils.PageDown ? pageDown(containerEl, itemEl, indexPositions, index) : await pageUp(containerEl, itemEl, indexPositions, index);
+        }
+      }
+      return result ?? index;
+    },
+    [containerRef, indexPositions]
+  );
+  const nextFocusableItemIdx = react.useCallback(
+    (key = keyUtils.ArrowDown, idx = key === keyUtils.ArrowDown ? -1 : indexPositions.length) => {
+      if (indexPositions.length === 0) {
+        return -1;
+      }
+      const indexOfSelectedItem = getIndexOfSelectedItem(
+        indexPositions,
+        selected
+      );
+      const startIdx = getStartIdx(
+        key,
+        idx,
+        indexOfSelectedItem,
+        indexPositions.length
+      );
+      let nextIdx = nextItemIdx(indexPositions.length, key, startIdx);
+      if (nextIdx === 0 && key === keyUtils.ArrowUp && !isFocusable(indexPositions[0])) {
+        return idx;
+      }
+      while (((key === keyUtils.ArrowDown || key === keyUtils.Home) && nextIdx < indexPositions.length || (key === keyUtils.ArrowUp || key === keyUtils.End) && nextIdx > 0) && !isFocusable(indexPositions[nextIdx])) {
+        nextIdx = nextItemIdx(indexPositions.length, key, nextIdx);
+      }
+      return nextIdx;
+    },
+    [indexPositions, selected]
+  );
+  const keyboardNavigation = react.useRef(false);
+  const ignoreFocus = react.useRef(false);
+  const setIgnoreFocus = react.useCallback(
+    (value) => ignoreFocus.current = value,
+    []
+  );
+  const handleFocus = react.useCallback(() => {
+    if (ignoreFocus.current) {
+      ignoreFocus.current = false;
+    } else {
+      keyboardNavigation.current = true;
+      if (indexPositions.length === 0) {
+        setHighlightedIndex(LIST_FOCUS_VISIBLE);
+      } else if (highlightedIndex !== -1) {
+        forceRender({});
+      } else if (restoreLastFocus) {
+        if (lastFocus.current !== -1) {
+          setHighlightedIndex(lastFocus.current);
+        } else {
+          const selectedItemIdx = getIndexOfSelectedItem(
+            indexPositions,
+            selected
+          );
+          if (selectedItemIdx !== -1) {
+            setHighlightedIndex(selectedItemIdx);
+          } else {
+            setHighlightedIndex(0);
+          }
+        }
+      } else if (selectionTypes.hasSelection(selected)) {
+        const selectedItemIdx = getIndexOfSelectedItem(
+          indexPositions,
+          selected
+        );
+        setHighlightedIndex(selectedItemIdx);
+      } else if (disableHighlightOnFocus !== true) {
+        setHighlightedIndex(nextFocusableItemIdx());
+      }
+    }
+  }, [
+    disableHighlightOnFocus,
+    highlightedIndex,
+    indexPositions,
+    nextFocusableItemIdx,
+    restoreLastFocus,
+    selected,
+    setHighlightedIndex
+  ]);
+  const navigateChildItems = react.useCallback(
+    async (e) => {
+      const nextIdx = e.key === keyUtils.PageDown || e.key === keyUtils.PageUp ? await nextPageItemIdx(e, highlightedIndex) : nextFocusableItemIdx(e.key, highlightedIndex);
+      if (nextIdx !== highlightedIndex) {
+        setHighlightedIndex(nextIdx, true);
+      }
+      onKeyboardNavigation == null ? void 0 : onKeyboardNavigation(e, nextIdx);
+    },
+    [
+      highlightedIndex,
+      nextFocusableItemIdx,
+      nextPageItemIdx,
+      onKeyboardNavigation,
+      setHighlightedIndex
+    ]
+  );
+  const handleKeyDown = react.useCallback(
+    (e) => {
+      if (indexPositions.length > 0 && keyUtils.isNavigationKey(e)) {
+        e.preventDefault();
+        e.stopPropagation();
+        keyboardNavigation.current = true;
+        void navigateChildItems(e);
+      } else if (keyUtils.isCharacterKey(e)) {
+        keyboardNavigation.current = true;
+      }
+    },
+    [indexPositions, navigateChildItems]
+  );
+  const listProps = react.useMemo(() => {
+    return {
+      onBlur: (e) => {
+        const sourceTarget = e.target.closest(".saltList");
+        const destTarget = e.relatedTarget;
+        if (sourceTarget && !(sourceTarget == null ? void 0 : sourceTarget.contains(destTarget))) {
+          keyboardNavigation.current = false;
+          setHighlightedIdx(-1);
+          if (!restoreLastFocus) {
+            lastFocus.current = -1;
+          }
+        }
+      },
+      onFocus: handleFocus,
+      onKeyDown: handleKeyDown,
+      onMouseDownCapture: () => {
+        keyboardNavigation.current = false;
+        setIgnoreFocus(true);
+      },
+      // onMouseEnter would seem less expensive but it misses some cases
+      onMouseMove: () => {
+        if (keyboardNavigation.current) {
+          keyboardNavigation.current = false;
+        }
+      },
+      onMouseLeave: () => {
+        keyboardNavigation.current = false;
+        setIgnoreFocus(false);
+        setHighlightedIndex(-1);
+      }
+    };
+  }, [
+    handleFocus,
+    handleKeyDown,
+    restoreLastFocus,
+    setHighlightedIndex,
+    setIgnoreFocus
+  ]);
+  return {
+    focusVisible: keyboardNavigation.current ? highlightedIndex : -1,
+    controlledHighlighting: isControlledHighlighting,
+    highlightedIndex,
+    setHighlightedIndex,
+    keyboardNavigation,
+    listProps,
+    setIgnoreFocus
+  };
+};
+
+exports.LIST_FOCUS_VISIBLE = LIST_FOCUS_VISIBLE;
+exports.useKeyboardNavigation = useKeyboardNavigation;
+//# sourceMappingURL=useKeyboardNavigation.js.map