@salt-ds/lab 1.0.0-alpha.0

package/dist-cjs/packages/lab/src/common-hooks/useKeyboardNavigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useKeyboardNavigation.js","sources":["../src/common-hooks/useKeyboardNavigation.ts"],"sourcesContent":["import { useControlled } from \"@salt-ds/core\";\nimport {\n  FocusEvent,\n  KeyboardEvent,\n  useCallback,\n  useMemo,\n  useRef,\n  useState,\n} from \"react\";\nimport {\n  ArrowDown,\n  ArrowUp,\n  End,\n  Home,\n  isCharacterKey,\n  isNavigationKey,\n  PageDown,\n  PageUp,\n} from \"./keyUtils\";\nimport { CollectionItem } from \"./collectionTypes\";\nimport { NavigationHookProps, NavigationHookResult } from \"./navigationTypes\";\nimport {\n  getFirstSelectedItem,\n  hasSelection,\n  SelectionStrategy,\n} from \"./selectionTypes\";\n\nexport const LIST_FOCUS_VISIBLE = -2;\n\nfunction nextItemIdx(count: number, key: string, idx: number) {\n  if (key === ArrowUp || key === End) {\n    if (idx > 0) {\n      return idx - 1;\n    } else {\n      return idx;\n    }\n  } else {\n    if (idx === null) {\n      return 0;\n    } else if (idx === count - 1) {\n      return idx;\n    } else {\n      return idx + 1;\n    }\n  }\n}\n\nconst getIndexOfSelectedItem = (\n  items: CollectionItem<unknown>[],\n  selected?: CollectionItem<unknown> | null | CollectionItem<unknown>[]\n) => {\n  const selectedItem = getFirstSelectedItem(selected);\n  if (selectedItem) {\n    return items.indexOf(selectedItem);\n  } else {\n    return -1;\n  }\n};\n\nconst getStartIdx = (\n  key: string,\n  idx: number,\n  selectedIdx: number,\n  length: number\n) => {\n  if (key === End) {\n    return length;\n  } else if (key === Home) {\n    return -1;\n  } else if (idx !== -1) {\n    return idx;\n  } else {\n    return selectedIdx;\n  }\n};\n\nconst getItemRect = (item: CollectionItem<unknown>) => {\n  const el = document.getElementById(item.id);\n  if (el) {\n    return el.getBoundingClientRect();\n  } else {\n    throw Error(\n      `useKeyboardNavigation.getItemRect no element found for item  #${item?.id}`\n    );\n  }\n};\n\nconst pageDown = (\n  containerEl: HTMLElement,\n  itemEl: HTMLElement,\n  indexPositions: CollectionItem<unknown>[],\n  index: number\n): number | undefined => {\n  const { top: itemTop } = itemEl.getBoundingClientRect();\n  const { scrollTop, clientHeight, scrollHeight } = containerEl;\n  const lastIndexPosition = indexPositions.length - 1;\n  const newScrollTop = Math.min(\n    scrollTop + clientHeight,\n    scrollHeight - clientHeight\n  );\n  if (newScrollTop !== scrollTop && index < lastIndexPosition) {\n    containerEl.scrollTo(0, newScrollTop);\n    // Might need to do this in a timeout, in case virtualized content has rendered\n    let nextIdx = index;\n    let nextRect;\n    do {\n      nextIdx += 1;\n      nextRect = getItemRect(indexPositions[nextIdx]);\n    } while (nextRect.top < itemTop && nextIdx < lastIndexPosition);\n    return nextIdx;\n  }\n};\n\nconst pageUp = async (\n  containerEl: HTMLElement,\n  itemEl: HTMLElement,\n  indexPositions: CollectionItem<unknown>[],\n  index: number\n): Promise<number | undefined> => {\n  const { top: itemTop } = itemEl.getBoundingClientRect();\n  const { scrollTop, clientHeight } = containerEl;\n  const newScrollTop = Math.max(scrollTop - clientHeight, 0);\n  if (newScrollTop !== scrollTop && index > 0) {\n    containerEl.scrollTo(0, newScrollTop);\n    return new Promise((resolve) => {\n      // We must defer this operation until after render. If Items are virtualized.\n      // we need to allow them to be rendered.\n      requestAnimationFrame(() => {\n        let nextIdx = index;\n        let nextRect;\n        do {\n          nextIdx -= 1;\n          nextRect = getItemRect(indexPositions[nextIdx]);\n        } while (nextRect.top > itemTop && nextIdx > 0);\n        resolve(nextIdx);\n      });\n    });\n  }\n};\n\nconst isLeaf = <Item>(item: CollectionItem<Item>): boolean =>\n  !item.header && !item.childNodes;\nconst isFocusable = <Item>(item: CollectionItem<Item>) =>\n  isLeaf(item) || item.expanded !== undefined;\n\nexport const useKeyboardNavigation = <\n  Item,\n  Selection extends SelectionStrategy\n>({\n  containerRef,\n  defaultHighlightedIndex = -1,\n  disableHighlightOnFocus,\n  highlightedIndex: highlightedIndexProp,\n  indexPositions,\n  onHighlight,\n  onKeyboardNavigation,\n  restoreLastFocus,\n  selected,\n}: NavigationHookProps<Item, Selection>): NavigationHookResult => {\n  const lastFocus = useRef(-1);\n  const [, forceRender] = useState({});\n  const [highlightedIndex, setHighlightedIdx, isControlledHighlighting] =\n    useControlled({\n      controlled: highlightedIndexProp,\n      default: defaultHighlightedIndex,\n      name: \"UseKeyboardNavigation\",\n    });\n\n  const setHighlightedIndex = useCallback(\n    (idx: number, fromKeyboard = false) => {\n      onHighlight?.(idx);\n      setHighlightedIdx(idx);\n      if (fromKeyboard) {\n        lastFocus.current = idx;\n      }\n    },\n    [onHighlight, setHighlightedIdx]\n  );\n\n  const nextPageItemIdx = useCallback(\n    async (e: KeyboardEvent, index: number): Promise<number> => {\n      const { id } = indexPositions[index];\n      let result: number | undefined;\n      if (id) {\n        const itemEl = document.getElementById(id);\n        const { current: containerEl } = containerRef;\n        if (itemEl && containerEl) {\n          result =\n            e.key === PageDown\n              ? pageDown(containerEl, itemEl, indexPositions, index)\n              : await pageUp(containerEl, itemEl, indexPositions, index);\n        }\n      }\n      return result ?? index;\n    },\n    [containerRef, indexPositions]\n  );\n\n  const nextFocusableItemIdx = useCallback(\n    (\n      key = ArrowDown,\n      idx: number = key === ArrowDown ? -1 : indexPositions.length\n    ) => {\n      if (indexPositions.length === 0) {\n        return -1;\n      } else {\n        const indexOfSelectedItem = getIndexOfSelectedItem(\n          indexPositions,\n          selected\n        );\n        // The start index is generally the highlightedIdx (passed in as idx).\n        // We don't need it for Home and End navigation.\n        // Special case where we have selection, but no highlighting - begin\n        // navigation from selected item.\n        const startIdx = getStartIdx(\n          key,\n          idx,\n          indexOfSelectedItem,\n          indexPositions.length\n        );\n\n        let nextIdx = nextItemIdx(indexPositions.length, key, startIdx);\n        // Guard against returning zero, when first item is a header or group\n        if (\n          nextIdx === 0 &&\n          key === ArrowUp &&\n          !isFocusable(indexPositions[0])\n        ) {\n          return idx;\n        }\n        while (\n          (((key === ArrowDown || key === Home) &&\n            nextIdx < indexPositions.length) ||\n            ((key === ArrowUp || key === End) && nextIdx > 0)) &&\n          !isFocusable(indexPositions[nextIdx])\n        ) {\n          nextIdx = nextItemIdx(indexPositions.length, key, nextIdx);\n        }\n        return nextIdx;\n      }\n    },\n    [indexPositions, selected]\n  );\n\n  // does this belong here or should it be a method passed in?\n  const keyboardNavigation = useRef(false);\n  const ignoreFocus = useRef<boolean>(false);\n  const setIgnoreFocus = (value: boolean) => (ignoreFocus.current = value);\n\n  const handleFocus = useCallback(\n    (e: FocusEvent) => {\n      // Ignore focus if mouse has been used\n      if (ignoreFocus.current) {\n        ignoreFocus.current = false;\n      } else {\n        // If mouse wan't used, then keyboard must have been\n        keyboardNavigation.current = true;\n        if (indexPositions.length === 0) {\n          setHighlightedIndex(LIST_FOCUS_VISIBLE);\n        } else if (highlightedIndex !== -1) {\n          // We need to force a render here. We're not changing the highlightedIdx, but we want to\n          // make sure we render with the correct focusVisible value. We don't store focusVisible\n          // in state, as there are places where we would double render, as highlightedIdx also changes.\n          forceRender({});\n        } else if (restoreLastFocus) {\n          if (lastFocus.current !== -1) {\n            setHighlightedIndex(lastFocus.current);\n          } else {\n            const selectedItemIdx = getIndexOfSelectedItem(\n              indexPositions,\n              selected\n            );\n            if (selectedItemIdx !== -1) {\n              setHighlightedIndex(selectedItemIdx);\n            } else {\n              setHighlightedIndex(0);\n            }\n          }\n        } else if (hasSelection(selected)) {\n          const selectedItemIdx = getIndexOfSelectedItem(\n            indexPositions,\n            selected\n          );\n          setHighlightedIndex(selectedItemIdx);\n        } else if (disableHighlightOnFocus !== true) {\n          setHighlightedIndex(nextFocusableItemIdx());\n        }\n      }\n    },\n    [\n      disableHighlightOnFocus,\n      highlightedIndex,\n      indexPositions,\n      nextFocusableItemIdx,\n      restoreLastFocus,\n      selected,\n      setHighlightedIndex,\n    ]\n  );\n\n  const navigateChildItems = useCallback(\n    async (e: KeyboardEvent) => {\n      const nextIdx =\n        e.key === PageDown || e.key === PageUp\n          ? await nextPageItemIdx(e, highlightedIndex)\n          : nextFocusableItemIdx(e.key, highlightedIndex);\n\n      console.log(\n        `useKeyboardNavigation navigateChildItems highlightedIndex = ${highlightedIndex} nextIdx = ${nextIdx}`\n      );\n\n      if (nextIdx !== highlightedIndex) {\n        setHighlightedIndex(nextIdx, true);\n      }\n      // Users may need to know that a Keyboard navigation event has been handled\n      // even if no actual navigation was effected. e.g. fine-grained control\n      // over aria-activedescendant requires this.\n      onKeyboardNavigation?.(e, nextIdx);\n    },\n    [\n      highlightedIndex,\n      nextFocusableItemIdx,\n      nextPageItemIdx,\n      onKeyboardNavigation,\n      setHighlightedIndex,\n    ]\n  );\n\n  const handleKeyDown = useCallback(\n    (e: KeyboardEvent) => {\n      if (indexPositions.length > 0 && isNavigationKey(e)) {\n        e.preventDefault();\n        e.stopPropagation();\n        keyboardNavigation.current = true;\n        void navigateChildItems(e);\n      } else if (isCharacterKey(e)) {\n        keyboardNavigation.current = true;\n      }\n    },\n    [indexPositions, navigateChildItems]\n  );\n\n  const listProps = useMemo(() => {\n    return {\n      onBlur: (e: FocusEvent) => {\n        //TODO no direct ref to List\n        const sourceTarget = (e.target as HTMLElement).closest(\".saltList\");\n        const destTarget = e.relatedTarget as HTMLElement;\n        if (sourceTarget && !sourceTarget?.contains(destTarget)) {\n          keyboardNavigation.current = false;\n          setHighlightedIdx(-1);\n          if (!restoreLastFocus) {\n            lastFocus.current = -1;\n          }\n        }\n      },\n      onFocus: handleFocus,\n      onKeyDown: handleKeyDown,\n      onMouseDownCapture: () => {\n        keyboardNavigation.current = false;\n        setIgnoreFocus(true);\n      },\n\n      // onMouseEnter would seem less expensive but it misses some cases\n      onMouseMove: () => {\n        if (keyboardNavigation.current) {\n          keyboardNavigation.current = false;\n        }\n      },\n      onMouseLeave: () => {\n        keyboardNavigation.current = false;\n        setIgnoreFocus(false);\n        setHighlightedIndex(-1);\n      },\n    };\n  }, [\n    handleFocus,\n    handleKeyDown,\n    restoreLastFocus,\n    setHighlightedIdx,\n    setHighlightedIndex,\n  ]);\n\n  return {\n    focusVisible: keyboardNavigation.current ? highlightedIndex : -1,\n    controlledHighlighting: isControlledHighlighting,\n    highlightedIndex,\n    setHighlightedIndex,\n    keyboardNavigation,\n    listProps,\n    setIgnoreFocus,\n  };\n};\n"],"names":["ArrowUp","End","getFirstSelectedItem","Home","useRef","useState","useControlled","useCallback","PageDown","ArrowDown","hasSelection","PageUp","isNavigationKey","isCharacterKey","useMemo"],"mappings":";;;;;;;;;AA2BO,MAAM,kBAAqB,GAAA,CAAA,EAAA;AAElC,SAAS,WAAA,CAAY,KAAe,EAAA,GAAA,EAAa,GAAa,EAAA;AAC5D,EAAI,IAAA,GAAA,KAAQA,gBAAW,IAAA,GAAA,KAAQC,YAAK,EAAA;AAClC,IAAA,IAAI,MAAM,CAAG,EAAA;AACX,MAAA,OAAO,GAAM,GAAA,CAAA,CAAA;AAAA,KACR,MAAA;AACL,MAAO,OAAA,GAAA,CAAA;AAAA,KACT;AAAA,GACK,MAAA;AACL,IAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,MAAO,OAAA,CAAA,CAAA;AAAA,KACT,MAAA,IAAW,GAAQ,KAAA,KAAA,GAAQ,CAAG,EAAA;AAC5B,MAAO,OAAA,GAAA,CAAA;AAAA,KACF,MAAA;AACL,MAAA,OAAO,GAAM,GAAA,CAAA,CAAA;AAAA,KACf;AAAA,GACF;AACF,CAAA;AAEA,MAAM,sBAAA,GAAyB,CAC7B,KAAA,EACA,QACG,KAAA;AACH,EAAM,MAAA,YAAA,GAAeC,oCAAqB,QAAQ,CAAA,CAAA;AAClD,EAAA,IAAI,YAAc,EAAA;AAChB,IAAO,OAAA,KAAA,CAAM,QAAQ,YAAY,CAAA,CAAA;AAAA,GAC5B,MAAA;AACL,IAAO,OAAA,CAAA,CAAA,CAAA;AAAA,GACT;AACF,CAAA,CAAA;AAEA,MAAM,WAAc,GAAA,CAClB,GACA,EAAA,GAAA,EACA,aACA,MACG,KAAA;AACH,EAAA,IAAI,QAAQD,YAAK,EAAA;AACf,IAAO,OAAA,MAAA,CAAA;AAAA,GACT,MAAA,IAAW,QAAQE,aAAM,EAAA;AACvB,IAAO,OAAA,CAAA,CAAA,CAAA;AAAA,GACT,MAAA,IAAW,QAAQ,CAAI,CAAA,EAAA;AACrB,IAAO,OAAA,GAAA,CAAA;AAAA,GACF,MAAA;AACL,IAAO,OAAA,WAAA,CAAA;AAAA,GACT;AACF,CAAA,CAAA;AAEA,MAAM,WAAA,GAAc,CAAC,IAAkC,KAAA;AACrD,EAAA,MAAM,EAAK,GAAA,QAAA,CAAS,cAAe,CAAA,IAAA,CAAK,EAAE,CAAA,CAAA;AAC1C,EAAA,IAAI,EAAI,EAAA;AACN,IAAA,OAAO,GAAG,qBAAsB,EAAA,CAAA;AAAA,GAC3B,MAAA;AACL,IAAM,MAAA,KAAA;AAAA,MACJ,iEAAiE,IAAM,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,IAAA,CAAA,EAAA,CAAA,CAAA;AAAA,KACzE,CAAA;AAAA,GACF;AACF,CAAA,CAAA;AAEA,MAAM,QAAW,GAAA,CACf,WACA,EAAA,MAAA,EACA,gBACA,KACuB,KAAA;AACvB,EAAA,MAAM,EAAE,GAAA,EAAK,OAAQ,EAAA,GAAI,OAAO,qBAAsB,EAAA,CAAA;AACtD,EAAA,MAAM,EAAE,SAAA,EAAW,YAAc,EAAA,YAAA,EAAiB,GAAA,WAAA,CAAA;AAClD,EAAM,MAAA,iBAAA,GAAoB,eAAe,MAAS,GAAA,CAAA,CAAA;AAClD,EAAA,MAAM,eAAe,IAAK,CAAA,GAAA;AAAA,IACxB,SAAY,GAAA,YAAA;AAAA,IACZ,YAAe,GAAA,YAAA;AAAA,GACjB,CAAA;AACA,EAAI,IAAA,YAAA,KAAiB,SAAa,IAAA,KAAA,GAAQ,iBAAmB,EAAA;AAC3D,IAAY,WAAA,CAAA,QAAA,CAAS,GAAG,YAAY,CAAA,CAAA;AAEpC,IAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,IAAI,IAAA,QAAA,CAAA;AACJ,IAAG,GAAA;AACD,MAAW,OAAA,IAAA,CAAA,CAAA;AACX,MAAW,QAAA,GAAA,WAAA,CAAY,eAAe,OAAQ,CAAA,CAAA,CAAA;AAAA,KACvC,QAAA,QAAA,CAAS,GAAM,GAAA,OAAA,IAAW,OAAU,GAAA,iBAAA,EAAA;AAC7C,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AACF,CAAA,CAAA;AAEA,MAAM,MAAS,GAAA,OACb,WACA,EAAA,MAAA,EACA,gBACA,KACgC,KAAA;AAChC,EAAA,MAAM,EAAE,GAAA,EAAK,OAAQ,EAAA,GAAI,OAAO,qBAAsB,EAAA,CAAA;AACtD,EAAM,MAAA,EAAE,SAAW,EAAA,YAAA,EAAiB,GAAA,WAAA,CAAA;AACpC,EAAA,MAAM,YAAe,GAAA,IAAA,CAAK,GAAI,CAAA,SAAA,GAAY,cAAc,CAAC,CAAA,CAAA;AACzD,EAAI,IAAA,YAAA,KAAiB,SAAa,IAAA,KAAA,GAAQ,CAAG,EAAA;AAC3C,IAAY,WAAA,CAAA,QAAA,CAAS,GAAG,YAAY,CAAA,CAAA;AACpC,IAAO,OAAA,IAAI,OAAQ,CAAA,CAAC,OAAY,KAAA;AAG9B,MAAA,qBAAA,CAAsB,MAAM;AAC1B,QAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,QAAI,IAAA,QAAA,CAAA;AACJ,QAAG,GAAA;AACD,UAAW,OAAA,IAAA,CAAA,CAAA;AACX,UAAW,QAAA,GAAA,WAAA,CAAY,eAAe,OAAQ,CAAA,CAAA,CAAA;AAAA,SACvC,QAAA,QAAA,CAAS,GAAM,GAAA,OAAA,IAAW,OAAU,GAAA,CAAA,EAAA;AAC7C,QAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AAAA,OAChB,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF,CAAA,CAAA;AAEA,MAAM,SAAS,CAAO,IAAA,KACpB,CAAC,IAAK,CAAA,MAAA,IAAU,CAAC,IAAK,CAAA,UAAA,CAAA;AACxB,MAAM,cAAc,CAAO,IAAA,KACzB,OAAO,IAAI,CAAA,IAAK,KAAK,QAAa,KAAA,KAAA,CAAA,CAAA;AAE7B,MAAM,wBAAwB,CAGnC;AAAA,EACA,YAAA;AAAA,EACA,uBAA0B,GAAA,CAAA,CAAA;AAAA,EAC1B,uBAAA;AAAA,EACA,gBAAkB,EAAA,oBAAA;AAAA,EAClB,cAAA;AAAA,EACA,WAAA;AAAA,EACA,oBAAA;AAAA,EACA,gBAAA;AAAA,EACA,QAAA;AACF,CAAkE,KAAA;AAChE,EAAM,MAAA,SAAA,GAAYC,aAAO,CAAE,CAAA,CAAA,CAAA;AAC3B,EAAA,MAAM,GAAG,WAAW,CAAI,GAAAC,cAAA,CAAS,EAAE,CAAA,CAAA;AACnC,EAAA,MAAM,CAAC,gBAAA,EAAkB,iBAAmB,EAAA,wBAAwB,IAClEC,kBAAc,CAAA;AAAA,IACZ,UAAY,EAAA,oBAAA;AAAA,IACZ,OAAS,EAAA,uBAAA;AAAA,IACT,IAAM,EAAA,uBAAA;AAAA,GACP,CAAA,CAAA;AAEH,EAAA,MAAM,mBAAsB,GAAAC,iBAAA;AAAA,IAC1B,CAAC,GAAa,EAAA,YAAA,GAAe,KAAU,KAAA;AACrC,MAAc,WAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,WAAA,CAAA,GAAA,CAAA,CAAA;AACd,MAAA,iBAAA,CAAkB,GAAG,CAAA,CAAA;AACrB,MAAA,IAAI,YAAc,EAAA;AAChB,QAAA,SAAA,CAAU,OAAU,GAAA,GAAA,CAAA;AAAA,OACtB;AAAA,KACF;AAAA,IACA,CAAC,aAAa,iBAAiB,CAAA;AAAA,GACjC,CAAA;AAEA,EAAA,MAAM,eAAkB,GAAAA,iBAAA;AAAA,IACtB,OAAO,GAAkB,KAAmC,KAAA;AAC1D,MAAM,MAAA,EAAE,EAAG,EAAA,GAAI,cAAe,CAAA,KAAA,CAAA,CAAA;AAC9B,MAAI,IAAA,MAAA,CAAA;AACJ,MAAA,IAAI,EAAI,EAAA;AACN,QAAM,MAAA,MAAA,GAAS,QAAS,CAAA,cAAA,CAAe,EAAE,CAAA,CAAA;AACzC,QAAM,MAAA,EAAE,OAAS,EAAA,WAAA,EAAgB,GAAA,YAAA,CAAA;AACjC,QAAA,IAAI,UAAU,WAAa,EAAA;AACzB,UAAA,MAAA,GACE,CAAE,CAAA,GAAA,KAAQC,iBACN,GAAA,QAAA,CAAS,aAAa,MAAQ,EAAA,cAAA,EAAgB,KAAK,CAAA,GACnD,MAAM,MAAA,CAAO,WAAa,EAAA,MAAA,EAAQ,gBAAgB,KAAK,CAAA,CAAA;AAAA,SAC/D;AAAA,OACF;AACA,MAAA,OAAO,MAAU,IAAA,IAAA,GAAA,MAAA,GAAA,KAAA,CAAA;AAAA,KACnB;AAAA,IACA,CAAC,cAAc,cAAc,CAAA;AAAA,GAC/B,CAAA;AAEA,EAAA,MAAM,oBAAuB,GAAAD,iBAAA;AAAA,IAC3B,CACE,MAAME,kBACN,EAAA,GAAA,GAAc,QAAQA,kBAAY,GAAA,CAAA,CAAA,GAAK,eAAe,MACnD,KAAA;AACH,MAAI,IAAA,cAAA,CAAe,WAAW,CAAG,EAAA;AAC/B,QAAO,OAAA,CAAA,CAAA,CAAA;AAAA,OACF,MAAA;AACL,QAAA,MAAM,mBAAsB,GAAA,sBAAA;AAAA,UAC1B,cAAA;AAAA,UACA,QAAA;AAAA,SACF,CAAA;AAKA,QAAA,MAAM,QAAW,GAAA,WAAA;AAAA,UACf,GAAA;AAAA,UACA,GAAA;AAAA,UACA,mBAAA;AAAA,UACA,cAAe,CAAA,MAAA;AAAA,SACjB,CAAA;AAEA,QAAA,IAAI,OAAU,GAAA,WAAA,CAAY,cAAe,CAAA,MAAA,EAAQ,KAAK,QAAQ,CAAA,CAAA;AAE9D,QACE,IAAA,OAAA,KAAY,KACZ,GAAQ,KAAAT,gBAAA,IACR,CAAC,WAAY,CAAA,cAAA,CAAe,EAAE,CAC9B,EAAA;AACA,UAAO,OAAA,GAAA,CAAA;AAAA,SACT;AACA,QAAA,OAAA,CAAA,CACK,QAAQS,kBAAa,IAAA,GAAA,KAAQN,aAC9B,KAAA,OAAA,GAAU,eAAe,MACvB,IAAA,CAAA,GAAA,KAAQH,gBAAW,IAAA,GAAA,KAAQC,iBAAQ,OAAU,GAAA,CAAA,KACjD,CAAC,WAAY,CAAA,cAAA,CAAe,QAAQ,CACpC,EAAA;AACA,UAAA,OAAA,GAAU,WAAY,CAAA,cAAA,CAAe,MAAQ,EAAA,GAAA,EAAK,OAAO,CAAA,CAAA;AAAA,SAC3D;AACA,QAAO,OAAA,OAAA,CAAA;AAAA,OACT;AAAA,KACF;AAAA,IACA,CAAC,gBAAgB,QAAQ,CAAA;AAAA,GAC3B,CAAA;AAGA,EAAM,MAAA,kBAAA,GAAqBG,aAAO,KAAK,CAAA,CAAA;AACvC,EAAM,MAAA,WAAA,GAAcA,aAAgB,KAAK,CAAA,CAAA;AACzC,EAAA,MAAM,cAAiB,GAAA,CAAC,KAAoB,KAAA,WAAA,CAAY,OAAU,GAAA,KAAA,CAAA;AAElE,EAAA,MAAM,WAAc,GAAAG,iBAAA;AAAA,IAClB,CAAC,CAAkB,KAAA;AAEjB,MAAA,IAAI,YAAY,OAAS,EAAA;AACvB,QAAA,WAAA,CAAY,OAAU,GAAA,KAAA,CAAA;AAAA,OACjB,MAAA;AAEL,QAAA,kBAAA,CAAmB,OAAU,GAAA,IAAA,CAAA;AAC7B,QAAI,IAAA,cAAA,CAAe,WAAW,CAAG,EAAA;AAC/B,UAAA,mBAAA,CAAoB,kBAAkB,CAAA,CAAA;AAAA,SACxC,MAAA,IAAW,qBAAqB,CAAI,CAAA,EAAA;AAIlC,UAAA,WAAA,CAAY,EAAE,CAAA,CAAA;AAAA,mBACL,gBAAkB,EAAA;AAC3B,UAAI,IAAA,SAAA,CAAU,YAAY,CAAI,CAAA,EAAA;AAC5B,YAAA,mBAAA,CAAoB,UAAU,OAAO,CAAA,CAAA;AAAA,WAChC,MAAA;AACL,YAAA,MAAM,eAAkB,GAAA,sBAAA;AAAA,cACtB,cAAA;AAAA,cACA,QAAA;AAAA,aACF,CAAA;AACA,YAAA,IAAI,oBAAoB,CAAI,CAAA,EAAA;AAC1B,cAAA,mBAAA,CAAoB,eAAe,CAAA,CAAA;AAAA,aAC9B,MAAA;AACL,cAAA,mBAAA,CAAoB,CAAC,CAAA,CAAA;AAAA,aACvB;AAAA,WACF;AAAA,SACF,MAAA,IAAWG,2BAAa,CAAA,QAAQ,CAAG,EAAA;AACjC,UAAA,MAAM,eAAkB,GAAA,sBAAA;AAAA,YACtB,cAAA;AAAA,YACA,QAAA;AAAA,WACF,CAAA;AACA,UAAA,mBAAA,CAAoB,eAAe,CAAA,CAAA;AAAA,SACrC,MAAA,IAAW,4BAA4B,IAAM,EAAA;AAC3C,UAAA,mBAAA,CAAoB,sBAAsB,CAAA,CAAA;AAAA,SAC5C;AAAA,OACF;AAAA,KACF;AAAA,IACA;AAAA,MACE,uBAAA;AAAA,MACA,gBAAA;AAAA,MACA,cAAA;AAAA,MACA,oBAAA;AAAA,MACA,gBAAA;AAAA,MACA,QAAA;AAAA,MACA,mBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,kBAAqB,GAAAH,iBAAA;AAAA,IACzB,OAAO,CAAqB,KAAA;AAC1B,MAAA,MAAM,OACJ,GAAA,CAAA,CAAE,GAAQ,KAAAC,iBAAA,IAAY,EAAE,GAAQ,KAAAG,eAAA,GAC5B,MAAM,eAAA,CAAgB,GAAG,gBAAgB,CAAA,GACzC,oBAAqB,CAAA,CAAA,CAAE,KAAK,gBAAgB,CAAA,CAAA;AAElD,MAAQ,OAAA,CAAA,GAAA;AAAA,QACN,+DAA+D,gBAA8B,CAAA,WAAA,EAAA,OAAA,CAAA,CAAA;AAAA,OAC/F,CAAA;AAEA,MAAA,IAAI,YAAY,gBAAkB,EAAA;AAChC,QAAA,mBAAA,CAAoB,SAAS,IAAI,CAAA,CAAA;AAAA,OACnC;AAIA,MAAA,oBAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,oBAAA,CAAuB,CAAG,EAAA,OAAA,CAAA,CAAA;AAAA,KAC5B;AAAA,IACA;AAAA,MACE,gBAAA;AAAA,MACA,oBAAA;AAAA,MACA,eAAA;AAAA,MACA,oBAAA;AAAA,MACA,mBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,aAAgB,GAAAJ,iBAAA;AAAA,IACpB,CAAC,CAAqB,KAAA;AACpB,MAAA,IAAI,cAAe,CAAA,MAAA,GAAS,CAAK,IAAAK,wBAAA,CAAgB,CAAC,CAAG,EAAA;AACnD,QAAA,CAAA,CAAE,cAAe,EAAA,CAAA;AACjB,QAAA,CAAA,CAAE,eAAgB,EAAA,CAAA;AAClB,QAAA,kBAAA,CAAmB,OAAU,GAAA,IAAA,CAAA;AAC7B,QAAA,KAAK,mBAAmB,CAAC,CAAA,CAAA;AAAA,OAC3B,MAAA,IAAWC,uBAAe,CAAA,CAAC,CAAG,EAAA;AAC5B,QAAA,kBAAA,CAAmB,OAAU,GAAA,IAAA,CAAA;AAAA,OAC/B;AAAA,KACF;AAAA,IACA,CAAC,gBAAgB,kBAAkB,CAAA;AAAA,GACrC,CAAA;AAEA,EAAM,MAAA,SAAA,GAAYC,cAAQ,MAAM;AAC9B,IAAO,OAAA;AAAA,MACL,MAAA,EAAQ,CAAC,CAAkB,KAAA;AAEzB,QAAA,MAAM,YAAgB,GAAA,CAAA,CAAE,MAAuB,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAClE,QAAA,MAAM,aAAa,CAAE,CAAA,aAAA,CAAA;AACrB,QAAA,IAAI,YAAgB,IAAA,EAAC,YAAc,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,YAAA,CAAA,QAAA,CAAS,UAAa,CAAA,CAAA,EAAA;AACvD,UAAA,kBAAA,CAAmB,OAAU,GAAA,KAAA,CAAA;AAC7B,UAAA,iBAAA,CAAkB,CAAE,CAAA,CAAA,CAAA;AACpB,UAAA,IAAI,CAAC,gBAAkB,EAAA;AACrB,YAAA,SAAA,CAAU,OAAU,GAAA,CAAA,CAAA,CAAA;AAAA,WACtB;AAAA,SACF;AAAA,OACF;AAAA,MACA,OAAS,EAAA,WAAA;AAAA,MACT,SAAW,EAAA,aAAA;AAAA,MACX,oBAAoB,MAAM;AACxB,QAAA,kBAAA,CAAmB,OAAU,GAAA,KAAA,CAAA;AAC7B,QAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAAA,OACrB;AAAA,MAGA,aAAa,MAAM;AACjB,QAAA,IAAI,mBAAmB,OAAS,EAAA;AAC9B,UAAA,kBAAA,CAAmB,OAAU,GAAA,KAAA,CAAA;AAAA,SAC/B;AAAA,OACF;AAAA,MACA,cAAc,MAAM;AAClB,QAAA,kBAAA,CAAmB,OAAU,GAAA,KAAA,CAAA;AAC7B,QAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AACpB,QAAA,mBAAA,CAAoB,CAAE,CAAA,CAAA,CAAA;AAAA,OACxB;AAAA,KACF,CAAA;AAAA,GACC,EAAA;AAAA,IACD,WAAA;AAAA,IACA,aAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,mBAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAO,OAAA;AAAA,IACL,YAAA,EAAc,kBAAmB,CAAA,OAAA,GAAU,gBAAmB,GAAA,CAAA,CAAA;AAAA,IAC9D,sBAAwB,EAAA,wBAAA;AAAA,IACxB,gBAAA;AAAA,IACA,mBAAA;AAAA,IACA,kBAAA;AAAA,IACA,SAAA;AAAA,IACA,cAAA;AAAA,GACF,CAAA;AACF;;;;;"}

package/dist-cjs/packages/lab/src/common-hooks/useKeyboardNavigationPanel.js

@@ -0,0 +1,148 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@salt-ds/core');
+var React = require('react');
+
+function nextItemIdx(count, direction, idx, cycleFocus = false) {
+  if (direction === "BWD") {
+    if (idx > 0) {
+      return idx - 1;
+    } else {
+      return cycleFocus ? count - 1 : idx;
+    }
+  } else {
+    if (idx === null) {
+      return 0;
+    } else if (idx === count - 1) {
+      return cycleFocus ? 0 : idx;
+    } else {
+      return idx + 1;
+    }
+  }
+}
+const isLeaf = (item) => !item.header && !item.childNodes;
+const isFocusable = (item) => (isLeaf(item) || item.expanded !== void 0) && item.focusable !== false;
+const useKeyboardNavigationPanel = ({
+  cycleFocus = false,
+  defaultHighlightedIndex: defaultHighlightedIdx = -1,
+  focusOnHighlight = false,
+  highlightedIndex: highlightedIdxProp,
+  indexPositions,
+  onHighlight,
+  onKeyboardNavigation
+}) => {
+  const [highlightedIdx, setHighlightedIdx, isControlledHighlighting] = core.useControlled({
+    controlled: highlightedIdxProp,
+    default: defaultHighlightedIdx,
+    name: "UseKeyboardNavigation"
+  });
+  const setHighlightedIndex = React.useCallback(
+    (idx) => {
+      onHighlight == null ? void 0 : onHighlight(idx);
+      setHighlightedIdx(idx);
+      if (focusOnHighlight && idx !== -1) {
+        const { id } = indexPositions[idx];
+        const formField = document.getElementById(id);
+        const targetEl = formField == null ? void 0 : formField.querySelector("[tabindex]");
+        setIgnoreFocus(true);
+        targetEl == null ? void 0 : targetEl.focus();
+      }
+    },
+    [focusOnHighlight, indexPositions, onHighlight, setHighlightedIdx]
+  );
+  const nextFocusableItemIdx = React.useCallback(
+    (direction = "FWD", idx = direction === "FWD" ? -1 : indexPositions.length) => {
+      let nextIdx = nextItemIdx(
+        indexPositions.length,
+        direction,
+        idx,
+        cycleFocus
+      );
+      while ((direction === "FWD" && nextIdx < indexPositions.length || direction === "BWD" && nextIdx > 0) && !isFocusable(indexPositions[nextIdx])) {
+        nextIdx = nextItemIdx(
+          indexPositions.length,
+          direction,
+          nextIdx,
+          cycleFocus
+        );
+      }
+      return nextIdx;
+    },
+    [cycleFocus, indexPositions]
+  );
+  const keyboardNavigation = React.useRef(true);
+  const ignoreFocus = React.useRef(false);
+  const setIgnoreFocus = (value) => ignoreFocus.current = value;
+  const handleFocus = React.useCallback(() => {
+    if (ignoreFocus.current) {
+      ignoreFocus.current = false;
+    } else {
+      setHighlightedIndex(nextFocusableItemIdx());
+    }
+  }, [nextFocusableItemIdx, setHighlightedIndex]);
+  const navigateChildItems = React.useCallback(
+    (e) => {
+      const direction = e.shiftKey ? "BWD" : "FWD";
+      const nextIdx = nextFocusableItemIdx(direction, highlightedIdx);
+      console.log(`nextFocusableItem from ${highlightedIdx} is ${nextIdx}`);
+      if (nextIdx !== highlightedIdx) {
+        setHighlightedIndex(nextIdx);
+        onKeyboardNavigation == null ? void 0 : onKeyboardNavigation(e, nextIdx);
+      }
+    },
+    [
+      highlightedIdx,
+      nextFocusableItemIdx,
+      onKeyboardNavigation,
+      setHighlightedIndex
+    ]
+  );
+  const handleKeyDown = React.useCallback(
+    (evt) => {
+      if (indexPositions.length > 0 && evt.key === "Tab") {
+        evt.preventDefault();
+        evt.stopPropagation();
+        keyboardNavigation.current = true;
+        navigateChildItems(evt);
+      }
+    },
+    [indexPositions, navigateChildItems]
+  );
+  const listProps = React.useMemo(
+    () => ({
+      onBlur: () => {
+      },
+      onFocus: handleFocus,
+      onKeyDown: handleKeyDown,
+      onMouseDownCapture: () => {
+        keyboardNavigation.current = false;
+        setIgnoreFocus(true);
+      },
+      onMouseMove: () => {
+        if (keyboardNavigation.current) {
+          keyboardNavigation.current = false;
+        }
+      },
+      onMouseLeave: () => {
+        keyboardNavigation.current = true;
+        setIgnoreFocus(false);
+        setHighlightedIndex(-1);
+      }
+    }),
+    [handleFocus, handleKeyDown, setHighlightedIndex]
+  );
+  return {
+    focusVisible: keyboardNavigation.current ? highlightedIdx : -1,
+    controlledHighlighting: isControlledHighlighting,
+    highlightedIndex: highlightedIdx,
+    setHighlightedIndex,
+    keyboardNavigation,
+    listProps,
+    setIgnoreFocus
+  };
+};
+
+exports.useKeyboardNavigationPanel = useKeyboardNavigationPanel;
+//# sourceMappingURL=useKeyboardNavigationPanel.js.map

package/dist-cjs/packages/lab/src/common-hooks/useKeyboardNavigationPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useKeyboardNavigationPanel.js","sources":["../src/common-hooks/useKeyboardNavigationPanel.ts"],"sourcesContent":["import { useControlled } from \"@salt-ds/core\";\nimport { KeyboardEvent, useCallback, useMemo, useRef } from \"react\";\nimport { Tab } from \"./keyUtils\";\nimport { CollectionItem } from \"./collectionTypes\";\nimport { NavigationProps, NavigationHookResult } from \"./navigationTypes\";\n\ntype NavigationDirection = \"FWD\" | \"BWD\";\n\nfunction nextItemIdx(\n  count: number,\n  direction: NavigationDirection,\n  idx: number,\n  cycleFocus = false\n) {\n  if (direction === \"BWD\") {\n    if (idx > 0) {\n      return idx - 1;\n    } else {\n      return cycleFocus ? count - 1 : idx;\n    }\n  } else {\n    if (idx === null) {\n      return 0;\n    } else if (idx === count - 1) {\n      return cycleFocus ? 0 : idx;\n    } else {\n      return idx + 1;\n    }\n  }\n}\n\nconst isLeaf = <Item>(item: CollectionItem<Item>): boolean =>\n  !item.header && !item.childNodes;\nconst isFocusable = <Item>(item: CollectionItem<Item>) =>\n  (isLeaf(item) || item.expanded !== undefined) && item.focusable !== false;\n\n// we need a way to set highlightedIdx when selection changes\nexport const useKeyboardNavigationPanel = ({\n  cycleFocus = false,\n  defaultHighlightedIndex: defaultHighlightedIdx = -1,\n  focusOnHighlight = false,\n  highlightedIndex: highlightedIdxProp,\n  indexPositions,\n  onHighlight,\n  onKeyboardNavigation,\n}: NavigationProps): NavigationHookResult => {\n  const [highlightedIdx, setHighlightedIdx, isControlledHighlighting] =\n    useControlled({\n      controlled: highlightedIdxProp,\n      default: defaultHighlightedIdx,\n      name: \"UseKeyboardNavigation\",\n    });\n\n  const setHighlightedIndex = useCallback(\n    (idx: number) => {\n      onHighlight?.(idx);\n      setHighlightedIdx(idx);\n      if (focusOnHighlight && idx !== -1) {\n        const { id } = indexPositions[idx];\n        const formField = document.getElementById(id);\n        const targetEl = formField?.querySelector(\"[tabindex]\") as HTMLElement;\n        setIgnoreFocus(true);\n        targetEl?.focus();\n      }\n    },\n    [focusOnHighlight, indexPositions, onHighlight, setHighlightedIdx]\n  );\n\n  const nextFocusableItemIdx = useCallback(\n    (\n      direction: NavigationDirection = \"FWD\",\n      idx = direction === \"FWD\" ? -1 : indexPositions.length\n    ) => {\n      let nextIdx = nextItemIdx(\n        indexPositions.length,\n        direction,\n        idx,\n        cycleFocus\n      );\n      while (\n        ((direction === \"FWD\" && nextIdx < indexPositions.length) ||\n          (direction === \"BWD\" && nextIdx > 0)) &&\n        !isFocusable(indexPositions[nextIdx])\n      ) {\n        nextIdx = nextItemIdx(\n          indexPositions.length,\n          direction,\n          nextIdx,\n          cycleFocus\n        );\n      }\n      return nextIdx;\n    },\n    [cycleFocus, indexPositions]\n  );\n\n  // does this belong here or should it be a method passed in?\n  const keyboardNavigation = useRef(true);\n  const ignoreFocus = useRef<boolean>(false);\n  const setIgnoreFocus = (value: boolean) => (ignoreFocus.current = value);\n\n  const handleFocus = useCallback(() => {\n    if (ignoreFocus.current) {\n      ignoreFocus.current = false;\n    } else {\n      setHighlightedIndex(nextFocusableItemIdx());\n    }\n  }, [nextFocusableItemIdx, setHighlightedIndex]);\n\n  const navigateChildItems = useCallback(\n    (e: React.KeyboardEvent) => {\n      const direction: NavigationDirection = e.shiftKey ? \"BWD\" : \"FWD\";\n      const nextIdx = nextFocusableItemIdx(direction, highlightedIdx);\n      console.log(`nextFocusableItem from ${highlightedIdx} is ${nextIdx}`);\n      if (nextIdx !== highlightedIdx) {\n        setHighlightedIndex(nextIdx);\n        // What exactly is the point of this ?\n        onKeyboardNavigation?.(e, nextIdx);\n      }\n    },\n    [\n      highlightedIdx,\n      nextFocusableItemIdx,\n      onKeyboardNavigation,\n      setHighlightedIndex,\n    ]\n  );\n\n  const handleKeyDown = useCallback(\n    (evt: KeyboardEvent) => {\n      if (indexPositions.length > 0 && evt.key === \"Tab\") {\n        evt.preventDefault();\n        evt.stopPropagation();\n        keyboardNavigation.current = true;\n        navigateChildItems(evt);\n      }\n    },\n    [indexPositions, navigateChildItems]\n  );\n\n  const listProps = useMemo(\n    () => ({\n      onBlur: () => {\n        // This sets highlightedIdx to -1 before a click on ListItem can effect selection\n        // maybe in a timeout\n        // setHighlightedIndex(-1);\n      },\n      onFocus: handleFocus,\n      // Does this have to be capture ? We'll have to change the types\n      // onKeyDownCapture: handleKeyDown,\n      onKeyDown: handleKeyDown,\n      onMouseDownCapture: () => {\n        keyboardNavigation.current = false;\n        setIgnoreFocus(true);\n      },\n\n      // onMouseEnter would seem less expensive but it misses some cases\n      onMouseMove: () => {\n        if (keyboardNavigation.current) {\n          keyboardNavigation.current = false;\n        }\n      },\n      onMouseLeave: () => {\n        keyboardNavigation.current = true;\n        setIgnoreFocus(false);\n        setHighlightedIndex(-1);\n      },\n    }),\n    [handleFocus, handleKeyDown, setHighlightedIndex]\n  );\n\n  return {\n    focusVisible: keyboardNavigation.current ? highlightedIdx : -1,\n    controlledHighlighting: isControlledHighlighting,\n    highlightedIndex: highlightedIdx,\n    setHighlightedIndex,\n    keyboardNavigation,\n    listProps,\n    setIgnoreFocus,\n  };\n};\n"],"names":["useControlled","useCallback","useRef","useMemo"],"mappings":";;;;;;;AAQA,SAAS,WACP,CAAA,KAAA,EACA,SACA,EAAA,GAAA,EACA,aAAa,KACb,EAAA;AACA,EAAA,IAAI,cAAc,KAAO,EAAA;AACvB,IAAA,IAAI,MAAM,CAAG,EAAA;AACX,MAAA,OAAO,GAAM,GAAA,CAAA,CAAA;AAAA,KACR,MAAA;AACL,MAAO,OAAA,UAAA,GAAa,QAAQ,CAAI,GAAA,GAAA,CAAA;AAAA,KAClC;AAAA,GACK,MAAA;AACL,IAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,MAAO,OAAA,CAAA,CAAA;AAAA,KACT,MAAA,IAAW,GAAQ,KAAA,KAAA,GAAQ,CAAG,EAAA;AAC5B,MAAA,OAAO,aAAa,CAAI,GAAA,GAAA,CAAA;AAAA,KACnB,MAAA;AACL,MAAA,OAAO,GAAM,GAAA,CAAA,CAAA;AAAA,KACf;AAAA,GACF;AACF,CAAA;AAEA,MAAM,SAAS,CAAO,IAAA,KACpB,CAAC,IAAK,CAAA,MAAA,IAAU,CAAC,IAAK,CAAA,UAAA,CAAA;AACxB,MAAM,WAAA,GAAc,CAAO,IAAA,KAAA,CACxB,MAAO,CAAA,IAAI,KAAK,IAAK,CAAA,QAAA,KAAa,KAAc,CAAA,KAAA,IAAA,CAAK,SAAc,KAAA,KAAA,CAAA;AAG/D,MAAM,6BAA6B,CAAC;AAAA,EACzC,UAAa,GAAA,KAAA;AAAA,EACb,yBAAyB,qBAAwB,GAAA,CAAA,CAAA;AAAA,EACjD,gBAAmB,GAAA,KAAA;AAAA,EACnB,gBAAkB,EAAA,kBAAA;AAAA,EAClB,cAAA;AAAA,EACA,WAAA;AAAA,EACA,oBAAA;AACF,CAA6C,KAAA;AAC3C,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAmB,EAAA,wBAAwB,IAChEA,kBAAc,CAAA;AAAA,IACZ,UAAY,EAAA,kBAAA;AAAA,IACZ,OAAS,EAAA,qBAAA;AAAA,IACT,IAAM,EAAA,uBAAA;AAAA,GACP,CAAA,CAAA;AAEH,EAAA,MAAM,mBAAsB,GAAAC,iBAAA;AAAA,IAC1B,CAAC,GAAgB,KAAA;AACf,MAAc,WAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,WAAA,CAAA,GAAA,CAAA,CAAA;AACd,MAAA,iBAAA,CAAkB,GAAG,CAAA,CAAA;AACrB,MAAI,IAAA,gBAAA,IAAoB,QAAQ,CAAI,CAAA,EAAA;AAClC,QAAM,MAAA,EAAE,EAAG,EAAA,GAAI,cAAe,CAAA,GAAA,CAAA,CAAA;AAC9B,QAAM,MAAA,SAAA,GAAY,QAAS,CAAA,cAAA,CAAe,EAAE,CAAA,CAAA;AAC5C,QAAM,MAAA,QAAA,GAAW,uCAAW,aAAc,CAAA,YAAA,CAAA,CAAA;AAC1C,QAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AACnB,QAAU,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAA,KAAA,EAAA,CAAA;AAAA,OACZ;AAAA,KACF;AAAA,IACA,CAAC,gBAAA,EAAkB,cAAgB,EAAA,WAAA,EAAa,iBAAiB,CAAA;AAAA,GACnE,CAAA;AAEA,EAAA,MAAM,oBAAuB,GAAAA,iBAAA;AAAA,IAC3B,CACE,YAAiC,KACjC,EAAA,GAAA,GAAM,cAAc,KAAQ,GAAA,CAAA,CAAA,GAAK,eAAe,MAC7C,KAAA;AACH,MAAA,IAAI,OAAU,GAAA,WAAA;AAAA,QACZ,cAAe,CAAA,MAAA;AAAA,QACf,SAAA;AAAA,QACA,GAAA;AAAA,QACA,UAAA;AAAA,OACF,CAAA;AACA,MAAA,OAAA,CACI,SAAc,KAAA,KAAA,IAAS,OAAU,GAAA,cAAA,CAAe,MAC/C,IAAA,SAAA,KAAc,KAAS,IAAA,OAAA,GAAU,CACpC,KAAA,CAAC,WAAY,CAAA,cAAA,CAAe,QAAQ,CACpC,EAAA;AACA,QAAU,OAAA,GAAA,WAAA;AAAA,UACR,cAAe,CAAA,MAAA;AAAA,UACf,SAAA;AAAA,UACA,OAAA;AAAA,UACA,UAAA;AAAA,SACF,CAAA;AAAA,OACF;AACA,MAAO,OAAA,OAAA,CAAA;AAAA,KACT;AAAA,IACA,CAAC,YAAY,cAAc,CAAA;AAAA,GAC7B,CAAA;AAGA,EAAM,MAAA,kBAAA,GAAqBC,aAAO,IAAI,CAAA,CAAA;AACtC,EAAM,MAAA,WAAA,GAAcA,aAAgB,KAAK,CAAA,CAAA;AACzC,EAAA,MAAM,cAAiB,GAAA,CAAC,KAAoB,KAAA,WAAA,CAAY,OAAU,GAAA,KAAA,CAAA;AAElE,EAAM,MAAA,WAAA,GAAcD,kBAAY,MAAM;AACpC,IAAA,IAAI,YAAY,OAAS,EAAA;AACvB,MAAA,WAAA,CAAY,OAAU,GAAA,KAAA,CAAA;AAAA,KACjB,MAAA;AACL,MAAA,mBAAA,CAAoB,sBAAsB,CAAA,CAAA;AAAA,KAC5C;AAAA,GACC,EAAA,CAAC,oBAAsB,EAAA,mBAAmB,CAAC,CAAA,CAAA;AAE9C,EAAA,MAAM,kBAAqB,GAAAA,iBAAA;AAAA,IACzB,CAAC,CAA2B,KAAA;AAC1B,MAAM,MAAA,SAAA,GAAiC,CAAE,CAAA,QAAA,GAAW,KAAQ,GAAA,KAAA,CAAA;AAC5D,MAAM,MAAA,OAAA,GAAU,oBAAqB,CAAA,SAAA,EAAW,cAAc,CAAA,CAAA;AAC9D,MAAQ,OAAA,CAAA,GAAA,CAAI,CAA0B,uBAAA,EAAA,cAAA,CAAA,IAAA,EAAqB,OAAS,CAAA,CAAA,CAAA,CAAA;AACpE,MAAA,IAAI,YAAY,cAAgB,EAAA;AAC9B,QAAA,mBAAA,CAAoB,OAAO,CAAA,CAAA;AAE3B,QAAA,oBAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,oBAAA,CAAuB,CAAG,EAAA,OAAA,CAAA,CAAA;AAAA,OAC5B;AAAA,KACF;AAAA,IACA;AAAA,MACE,cAAA;AAAA,MACA,oBAAA;AAAA,MACA,oBAAA;AAAA,MACA,mBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,aAAgB,GAAAA,iBAAA;AAAA,IACpB,CAAC,GAAuB,KAAA;AACtB,MAAA,IAAI,cAAe,CAAA,MAAA,GAAS,CAAK,IAAA,GAAA,CAAI,QAAQ,KAAO,EAAA;AAClD,QAAA,GAAA,CAAI,cAAe,EAAA,CAAA;AACnB,QAAA,GAAA,CAAI,eAAgB,EAAA,CAAA;AACpB,QAAA,kBAAA,CAAmB,OAAU,GAAA,IAAA,CAAA;AAC7B,QAAA,kBAAA,CAAmB,GAAG,CAAA,CAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,CAAC,gBAAgB,kBAAkB,CAAA;AAAA,GACrC,CAAA;AAEA,EAAA,MAAM,SAAY,GAAAE,aAAA;AAAA,IAChB,OAAO;AAAA,MACL,QAAQ,MAAM;AAAA,OAId;AAAA,MACA,OAAS,EAAA,WAAA;AAAA,MAGT,SAAW,EAAA,aAAA;AAAA,MACX,oBAAoB,MAAM;AACxB,QAAA,kBAAA,CAAmB,OAAU,GAAA,KAAA,CAAA;AAC7B,QAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAAA,OACrB;AAAA,MAGA,aAAa,MAAM;AACjB,QAAA,IAAI,mBAAmB,OAAS,EAAA;AAC9B,UAAA,kBAAA,CAAmB,OAAU,GAAA,KAAA,CAAA;AAAA,SAC/B;AAAA,OACF;AAAA,MACA,cAAc,MAAM;AAClB,QAAA,kBAAA,CAAmB,OAAU,GAAA,IAAA,CAAA;AAC7B,QAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AACpB,QAAA,mBAAA,CAAoB,CAAE,CAAA,CAAA,CAAA;AAAA,OACxB;AAAA,KACF,CAAA;AAAA,IACA,CAAC,WAAa,EAAA,aAAA,EAAe,mBAAmB,CAAA;AAAA,GAClD,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,YAAA,EAAc,kBAAmB,CAAA,OAAA,GAAU,cAAiB,GAAA,CAAA,CAAA;AAAA,IAC5D,sBAAwB,EAAA,wBAAA;AAAA,IACxB,gBAAkB,EAAA,cAAA;AAAA,IAClB,mBAAA;AAAA,IACA,kBAAA;AAAA,IACA,SAAA;AAAA,IACA,cAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/dist-cjs/packages/lab/src/common-hooks/useSelection.js

@@ -0,0 +1,204 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@salt-ds/core');
+var React = require('react');
+
+const GROUP_SELECTION_NONE = "none";
+const defaultSelectionKeys = ["Enter", " "];
+const isSelectable = (item) => item && item.disabled !== true && item.selectable !== false;
+const byItemIndex = (i1, i2) => {
+  var _a, _b;
+  return ((_a = i1.index) != null ? _a : 0) - ((_b = i2.index) != null ? _b : 0);
+};
+const useSelection = ({
+  defaultSelected,
+  disableSelection = false,
+  highlightedIdx,
+  indexPositions,
+  label = "",
+  onSelect,
+  onSelectionChange,
+  selected: selectedProp,
+  selectionStrategy,
+  selectionKeys = defaultSelectionKeys,
+  tabToSelect
+}) => {
+  const isDeselectable = selectionStrategy === "deselectable";
+  const isMultipleSelect = selectionStrategy === "multiple";
+  const isExtendedSelect = selectionStrategy === "extended";
+  const lastActive = React.useRef(-1);
+  const isSelectionEvent = React.useCallback(
+    (evt) => selectionKeys.includes(evt.key),
+    [selectionKeys]
+  );
+  const emptyValue = React.useCallback(() => {
+    return isMultipleSelect || isExtendedSelect ? [] : null;
+  }, [isMultipleSelect, isExtendedSelect]);
+  const [selected, setSelected] = core.useControlled({
+    controlled: selectedProp,
+    default: defaultSelected != null ? defaultSelected : emptyValue(),
+    name: "UseSelection",
+    state: "selected"
+  });
+  const isItemSelected = React.useCallback(
+    (item) => {
+      return Array.isArray(selected) ? selected.includes(item) : selected === item;
+    },
+    [selected]
+  );
+  const selectDefault = React.useCallback((item) => item, []);
+  const selectDeselectable = React.useCallback(
+    (item) => isItemSelected(item) ? null : item,
+    [isItemSelected]
+  );
+  const selectMultiple = React.useCallback(
+    (item) => {
+      const nextItems = isItemSelected(item) ? selected.filter((i) => i !== item) : selected.concat(item);
+      nextItems.sort(byItemIndex);
+      return nextItems;
+    },
+    [isItemSelected, selected]
+  );
+  const selectRange = React.useCallback(
+    (idx, preserveExistingSelection) => {
+      const currentSelection = preserveExistingSelection ? selected : [];
+      const [lastSelectedItem] = selected.slice(-1);
+      const lastSelectedItemIndex = lastSelectedItem ? indexPositions.indexOf(lastSelectedItem) : 0;
+      const startRegion = Math.min(idx, lastSelectedItemIndex);
+      const endRegion = Math.max(idx, lastSelectedItemIndex);
+      const rangeSelection = indexPositions.slice(startRegion, endRegion + 1);
+      const nextItems = [.../* @__PURE__ */ new Set([...currentSelection, ...rangeSelection])];
+      nextItems.sort(byItemIndex);
+      return nextItems;
+    },
+    [indexPositions, selected]
+  );
+  const selectItemAtIndex = React.useCallback(
+    (evt, idx, item, rangeSelect, preserveExistingSelection) => {
+      let newSelected;
+      if (isMultipleSelect) {
+        newSelected = selectMultiple(item);
+      } else if (isExtendedSelect) {
+        if (preserveExistingSelection && !rangeSelect) {
+          newSelected = selectMultiple(item);
+        } else if (rangeSelect) {
+          newSelected = selectRange(
+            idx,
+            preserveExistingSelection
+          );
+        } else {
+          newSelected = [item];
+        }
+      } else if (isDeselectable) {
+        newSelected = selectDeselectable(item);
+      } else {
+        newSelected = selectDefault(item);
+      }
+      if (newSelected !== selected) {
+        setSelected(newSelected);
+      }
+      onSelect == null ? void 0 : onSelect(evt, item);
+      if (newSelected !== selected) {
+        if (onSelectionChange) {
+          onSelectionChange(evt, newSelected);
+        }
+      }
+    },
+    [
+      isMultipleSelect,
+      isExtendedSelect,
+      isDeselectable,
+      selected,
+      onSelect,
+      selectMultiple,
+      selectRange,
+      selectDeselectable,
+      selectDefault,
+      setSelected,
+      onSelectionChange
+    ]
+  );
+  const handleKeyDown = React.useCallback(
+    (evt) => {
+      const item = indexPositions[highlightedIdx];
+      if (isSelectable(item)) {
+        if (isSelectionEvent(evt) || tabToSelect && evt.key === "Tab") {
+          if (evt.key !== "Tab") {
+            evt.preventDefault();
+          }
+          selectItemAtIndex(
+            evt,
+            highlightedIdx,
+            item,
+            false,
+            evt.ctrlKey || evt.metaKey
+          );
+          if (isExtendedSelect) {
+            lastActive.current = highlightedIdx;
+          }
+        }
+      }
+    },
+    [
+      indexPositions,
+      highlightedIdx,
+      isSelectionEvent,
+      tabToSelect,
+      selectItemAtIndex,
+      isExtendedSelect
+    ]
+  );
+  const handleKeyboardNavigation = React.useCallback(
+    (evt, currentIndex) => {
+      if (isExtendedSelect && evt.shiftKey) {
+        const item = indexPositions[currentIndex];
+        if (isSelectable(item)) {
+          selectItemAtIndex(evt, currentIndex, item, true);
+        }
+      }
+    },
+    [isExtendedSelect, indexPositions, selectItemAtIndex]
+  );
+  const handleClick = React.useCallback(
+    (evt) => {
+      const item = indexPositions[highlightedIdx];
+      if (!disableSelection && isSelectable(item)) {
+        evt.preventDefault();
+        evt.stopPropagation();
+        selectItemAtIndex(
+          evt,
+          highlightedIdx,
+          item,
+          evt.shiftKey,
+          evt.ctrlKey || evt.metaKey
+        );
+        if (isExtendedSelect) {
+          lastActive.current = highlightedIdx;
+        }
+      }
+    },
+    [
+      disableSelection,
+      isExtendedSelect,
+      highlightedIdx,
+      indexPositions,
+      selectItemAtIndex
+    ]
+  );
+  const listHandlers = {
+    onClick: handleClick,
+    onKeyDown: handleKeyDown,
+    onKeyboardNavigation: handleKeyboardNavigation
+  };
+  return {
+    listHandlers,
+    selected,
+    setSelected
+  };
+};
+
+exports.GROUP_SELECTION_NONE = GROUP_SELECTION_NONE;
+exports.useSelection = useSelection;
+//# sourceMappingURL=useSelection.js.map

package/dist-cjs/packages/lab/src/common-hooks/useSelection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSelection.js","sources":["../src/common-hooks/useSelection.ts"],"sourcesContent":["import { useControlled } from \"@salt-ds/core\";\nimport { KeyboardEvent, MouseEvent, useCallback, useRef } from \"react\";\nimport { CollectionItem } from \"./collectionTypes\";\nimport {\n  SelectionHookProps,\n  SelectionHookResult,\n  SelectionStrategy,\n  SingleSelectionStrategy,\n} from \"./selectionTypes\";\n\nexport const CHECKBOX = \"checkbox\";\n\nexport const GROUP_SELECTION_NONE = \"none\";\nexport const GROUP_SELECTION_SINGLE = \"single\";\nexport const GROUP_SELECTION_CASCADE = \"cascade\";\n\nexport type GroupSelectionMode = \"none\" | \"single\" | \"cascade\";\n\nconst defaultSelectionKeys = [\"Enter\", \" \"];\n\nconst isSelectable = (item?: CollectionItem<unknown>) =>\n  item && item.disabled !== true && item.selectable !== false;\n\nconst byItemIndex = (\n  i1: CollectionItem<unknown>,\n  i2: CollectionItem<unknown>\n) => (i1.index ?? 0) - (i2.index ?? 0);\n\nexport const groupSelectionEnabled = (\n  groupSelection: GroupSelectionMode\n): boolean => groupSelection && groupSelection !== GROUP_SELECTION_NONE;\n\nexport const useSelection = <\n  Item,\n  Selection extends SelectionStrategy = \"default\"\n>({\n  defaultSelected,\n  disableSelection = false,\n  // groupSelection = GROUP_SELECTION_NONE,\n  highlightedIdx,\n  indexPositions,\n  label = \"\",\n  onSelect,\n  onSelectionChange,\n  selected: selectedProp,\n  selectionStrategy,\n  selectionKeys = defaultSelectionKeys,\n  tabToSelect,\n}: SelectionHookProps<Item, Selection>): SelectionHookResult<\n  Item,\n  Selection\n> => {\n  type collectionItem = CollectionItem<Item>;\n\n  const isDeselectable = selectionStrategy === \"deselectable\";\n  const isMultipleSelect = selectionStrategy === \"multiple\";\n  const isExtendedSelect = selectionStrategy === \"extended\";\n\n  const lastActive = useRef(-1);\n\n  const isSelectionEvent = useCallback(\n    (evt: KeyboardEvent) => selectionKeys.includes(evt.key),\n    [selectionKeys]\n  );\n\n  const emptyValue = useCallback(<\n    Item\n  >(): Selection extends SingleSelectionStrategy\n    ? null\n    : CollectionItem<Item>[] => {\n    type returnType = Selection extends SingleSelectionStrategy\n      ? null\n      : CollectionItem<Item>[];\n    return isMultipleSelect || isExtendedSelect\n      ? ([] as unknown as returnType)\n      : (null as returnType);\n  }, [isMultipleSelect, isExtendedSelect]);\n\n  const [selected, setSelected] = useControlled<\n    Selection extends SingleSelectionStrategy\n      ? CollectionItem<Item> | null\n      : CollectionItem<Item>[]\n  >({\n    controlled: selectedProp,\n    default: defaultSelected ?? emptyValue(),\n    name: \"UseSelection\",\n    state: \"selected\",\n  });\n\n  const isItemSelected = useCallback(\n    (item: collectionItem) => {\n      return Array.isArray(selected)\n        ? selected.includes(item)\n        : selected === item;\n    },\n    [selected]\n  );\n\n  const selectDefault = useCallback((item: collectionItem) => item, []);\n  const selectDeselectable = useCallback(\n    (item: collectionItem) => (isItemSelected(item) ? null : item),\n    [isItemSelected]\n  );\n  const selectMultiple = useCallback(\n    (item: collectionItem) => {\n      const nextItems = isItemSelected(item)\n        ? (selected as collectionItem[]).filter((i) => i !== item)\n        : (selected as collectionItem[]).concat(item);\n      nextItems.sort(byItemIndex);\n      return nextItems;\n    },\n    [isItemSelected, selected]\n  );\n  const selectRange = useCallback(\n    (idx: number, preserveExistingSelection?: boolean) => {\n      const currentSelection = preserveExistingSelection\n        ? (selected as collectionItem[])\n        : ([] as collectionItem[]);\n\n      const [lastSelectedItem] = (selected as collectionItem[]).slice(-1);\n      const lastSelectedItemIndex = lastSelectedItem\n        ? indexPositions.indexOf(lastSelectedItem)\n        : 0;\n\n      const startRegion = Math.min(idx, lastSelectedItemIndex);\n      const endRegion = Math.max(idx, lastSelectedItemIndex);\n      const rangeSelection = indexPositions.slice(startRegion, endRegion + 1);\n      // concat the current selection with a new selection and remove duplicates for overlaps\n      const nextItems = [...new Set([...currentSelection, ...rangeSelection])];\n      nextItems.sort(byItemIndex);\n      return nextItems;\n    },\n    [indexPositions, selected]\n  );\n\n  const selectItemAtIndex = useCallback(\n    (\n      evt: any,\n      idx: number,\n      item: collectionItem,\n      rangeSelect: boolean,\n      preserveExistingSelection?: boolean\n    ) => {\n      type returnType = Selection extends SingleSelectionStrategy\n        ? CollectionItem<Item> | null\n        : CollectionItem<Item>[];\n      let newSelected: returnType;\n      if (isMultipleSelect) {\n        newSelected = selectMultiple(item) as returnType;\n      } else if (isExtendedSelect) {\n        if (preserveExistingSelection && !rangeSelect) {\n          newSelected = selectMultiple(item) as returnType;\n        } else if (rangeSelect) {\n          newSelected = selectRange(\n            idx,\n            preserveExistingSelection\n          ) as returnType;\n        } else {\n          newSelected = [item] as returnType;\n        }\n      } else if (isDeselectable) {\n        newSelected = selectDeselectable(item) as returnType;\n      } else {\n        newSelected = selectDefault(item) as returnType;\n      }\n\n      if (newSelected !== selected) {\n        setSelected(newSelected);\n      }\n\n      // We fire onSelect irrespective of whether selection changes\n      onSelect?.(evt, item);\n\n      if (newSelected !== selected) {\n        if (onSelectionChange) {\n          onSelectionChange(evt, newSelected);\n        }\n      }\n    },\n    [\n      isMultipleSelect,\n      isExtendedSelect,\n      isDeselectable,\n      selected,\n      onSelect,\n      selectMultiple,\n      selectRange,\n      selectDeselectable,\n      selectDefault,\n      setSelected,\n      onSelectionChange,\n    ]\n  );\n\n  const handleKeyDown = useCallback(\n    (evt: KeyboardEvent) => {\n      const item = indexPositions[highlightedIdx];\n      if (isSelectable(item)) {\n        if (isSelectionEvent(evt) || (tabToSelect && evt.key === \"Tab\")) {\n          // We do not inhibit Tab behaviour, if we are selecting on Tab then we apply\n          // selection as a side effect of the Tab, not as a replacement for Tabbing.\n          if (evt.key !== \"Tab\") {\n            evt.preventDefault();\n          }\n          selectItemAtIndex(\n            evt,\n            highlightedIdx,\n            item,\n            false,\n            evt.ctrlKey || evt.metaKey\n          );\n          if (isExtendedSelect) {\n            lastActive.current = highlightedIdx;\n          }\n        }\n      }\n    },\n    [\n      indexPositions,\n      highlightedIdx,\n      isSelectionEvent,\n      tabToSelect,\n      selectItemAtIndex,\n      isExtendedSelect,\n    ]\n  );\n\n  const handleKeyboardNavigation = useCallback(\n    (evt: KeyboardEvent, currentIndex: number) => {\n      if (isExtendedSelect && evt.shiftKey) {\n        const item = indexPositions[currentIndex];\n        if (isSelectable(item)) {\n          selectItemAtIndex(evt, currentIndex, item, true);\n        }\n      }\n    },\n    [isExtendedSelect, indexPositions, selectItemAtIndex]\n  );\n\n  const handleClick = useCallback(\n    (evt: MouseEvent) => {\n      const item = indexPositions[highlightedIdx];\n      if (!disableSelection && isSelectable(item)) {\n        // if (!isCollapsibleItem(item)) {\n        evt.preventDefault();\n        evt.stopPropagation();\n        selectItemAtIndex(\n          evt,\n          highlightedIdx,\n          item,\n          evt.shiftKey,\n          evt.ctrlKey || evt.metaKey\n        );\n        if (isExtendedSelect) {\n          lastActive.current = highlightedIdx;\n        }\n        // }\n      }\n    },\n    [\n      disableSelection,\n      isExtendedSelect,\n      highlightedIdx,\n      indexPositions,\n      selectItemAtIndex,\n    ]\n  );\n\n  const listHandlers = {\n    onClick: handleClick,\n    onKeyDown: handleKeyDown,\n    onKeyboardNavigation: handleKeyboardNavigation,\n  };\n\n  return {\n    listHandlers,\n    selected,\n    setSelected,\n  };\n};\n"],"names":["useRef","useCallback","useControlled"],"mappings":";;;;;;;AAYO,MAAM,oBAAuB,GAAA,OAAA;AAMpC,MAAM,oBAAA,GAAuB,CAAC,OAAA,EAAS,GAAG,CAAA,CAAA;AAE1C,MAAM,YAAA,GAAe,CAAC,IACpB,KAAA,IAAA,IAAQ,KAAK,QAAa,KAAA,IAAA,IAAQ,KAAK,UAAe,KAAA,KAAA,CAAA;AAExD,MAAM,WAAA,GAAc,CAClB,EAAA,EACA,EACA,KAAA;AA1BF,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA0BM,EAAA,OAAA,CAAA,CAAA,EAAA,GAAA,EAAA,CAAG,KAAH,KAAA,IAAA,GAAA,EAAA,GAAY,CAAM,KAAA,CAAA,EAAA,GAAA,EAAA,CAAG,UAAH,IAAY,GAAA,EAAA,GAAA,CAAA,CAAA,CAAA;AAAA,CAAA,CAAA;AAM7B,MAAM,eAAe,CAG1B;AAAA,EACA,eAAA;AAAA,EACA,gBAAmB,GAAA,KAAA;AAAA,EAEnB,cAAA;AAAA,EACA,cAAA;AAAA,EACA,KAAQ,GAAA,EAAA;AAAA,EACR,QAAA;AAAA,EACA,iBAAA;AAAA,EACA,QAAU,EAAA,YAAA;AAAA,EACV,iBAAA;AAAA,EACA,aAAgB,GAAA,oBAAA;AAAA,EAChB,WAAA;AACF,CAGK,KAAA;AAGH,EAAA,MAAM,iBAAiB,iBAAsB,KAAA,cAAA,CAAA;AAC7C,EAAA,MAAM,mBAAmB,iBAAsB,KAAA,UAAA,CAAA;AAC/C,EAAA,MAAM,mBAAmB,iBAAsB,KAAA,UAAA,CAAA;AAE/C,EAAM,MAAA,UAAA,GAAaA,aAAO,CAAE,CAAA,CAAA,CAAA;AAE5B,EAAA,MAAM,gBAAmB,GAAAC,iBAAA;AAAA,IACvB,CAAC,GAAA,KAAuB,aAAc,CAAA,QAAA,CAAS,IAAI,GAAG,CAAA;AAAA,IACtD,CAAC,aAAa,CAAA;AAAA,GAChB,CAAA;AAEA,EAAM,MAAA,UAAA,GAAaA,kBAAY,MAID;AAI5B,IAAO,OAAA,gBAAA,IAAoB,gBACtB,GAAA,EACA,GAAA,IAAA,CAAA;AAAA,GACJ,EAAA,CAAC,gBAAkB,EAAA,gBAAgB,CAAC,CAAA,CAAA;AAEvC,EAAA,MAAM,CAAC,QAAA,EAAU,WAAW,CAAA,GAAIC,kBAI9B,CAAA;AAAA,IACA,UAAY,EAAA,YAAA;AAAA,IACZ,OAAA,EAAS,4CAAmB,UAAW,EAAA;AAAA,IACvC,IAAM,EAAA,cAAA;AAAA,IACN,KAAO,EAAA,UAAA;AAAA,GACR,CAAA,CAAA;AAED,EAAA,MAAM,cAAiB,GAAAD,iBAAA;AAAA,IACrB,CAAC,IAAyB,KAAA;AACxB,MAAO,OAAA,KAAA,CAAM,QAAQ,QAAQ,CAAA,GACzB,SAAS,QAAS,CAAA,IAAI,IACtB,QAAa,KAAA,IAAA,CAAA;AAAA,KACnB;AAAA,IACA,CAAC,QAAQ,CAAA;AAAA,GACX,CAAA;AAEA,EAAA,MAAM,gBAAgBA,iBAAY,CAAA,CAAC,IAAyB,KAAA,IAAA,EAAM,EAAE,CAAA,CAAA;AACpE,EAAA,MAAM,kBAAqB,GAAAA,iBAAA;AAAA,IACzB,CAAC,IAAA,KAA0B,cAAe,CAAA,IAAI,IAAI,IAAO,GAAA,IAAA;AAAA,IACzD,CAAC,cAAc,CAAA;AAAA,GACjB,CAAA;AACA,EAAA,MAAM,cAAiB,GAAAA,iBAAA;AAAA,IACrB,CAAC,IAAyB,KAAA;AACxB,MAAA,MAAM,SAAY,GAAA,cAAA,CAAe,IAAI,CAAA,GAChC,QAA8B,CAAA,MAAA,CAAO,CAAC,CAAA,KAAM,CAAM,KAAA,IAAI,CACtD,GAAA,QAAA,CAA8B,OAAO,IAAI,CAAA,CAAA;AAC9C,MAAA,SAAA,CAAU,KAAK,WAAW,CAAA,CAAA;AAC1B,MAAO,OAAA,SAAA,CAAA;AAAA,KACT;AAAA,IACA,CAAC,gBAAgB,QAAQ,CAAA;AAAA,GAC3B,CAAA;AACA,EAAA,MAAM,WAAc,GAAAA,iBAAA;AAAA,IAClB,CAAC,KAAa,yBAAwC,KAAA;AACpD,MAAM,MAAA,gBAAA,GAAmB,yBACpB,GAAA,QAAA,GACA,EAAC,CAAA;AAEN,MAAA,MAAM,CAAC,gBAAgB,CAAK,GAAA,QAAA,CAA8B,MAAM,CAAE,CAAA,CAAA,CAAA;AAClE,MAAA,MAAM,qBAAwB,GAAA,gBAAA,GAC1B,cAAe,CAAA,OAAA,CAAQ,gBAAgB,CACvC,GAAA,CAAA,CAAA;AAEJ,MAAA,MAAM,WAAc,GAAA,IAAA,CAAK,GAAI,CAAA,GAAA,EAAK,qBAAqB,CAAA,CAAA;AACvD,MAAA,MAAM,SAAY,GAAA,IAAA,CAAK,GAAI,CAAA,GAAA,EAAK,qBAAqB,CAAA,CAAA;AACrD,MAAA,MAAM,cAAiB,GAAA,cAAA,CAAe,KAAM,CAAA,WAAA,EAAa,YAAY,CAAC,CAAA,CAAA;AAEtE,MAAM,MAAA,SAAA,GAAY,CAAC,mBAAO,IAAA,GAAA,CAAI,CAAC,GAAG,gBAAkB,EAAA,GAAG,cAAc,CAAC,CAAC,CAAA,CAAA;AACvE,MAAA,SAAA,CAAU,KAAK,WAAW,CAAA,CAAA;AAC1B,MAAO,OAAA,SAAA,CAAA;AAAA,KACT;AAAA,IACA,CAAC,gBAAgB,QAAQ,CAAA;AAAA,GAC3B,CAAA;AAEA,EAAA,MAAM,iBAAoB,GAAAA,iBAAA;AAAA,IACxB,CACE,GAAA,EACA,GACA,EAAA,IAAA,EACA,aACA,yBACG,KAAA;AAIH,MAAI,IAAA,WAAA,CAAA;AACJ,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAA,WAAA,GAAc,eAAe,IAAI,CAAA,CAAA;AAAA,iBACxB,gBAAkB,EAAA;AAC3B,QAAI,IAAA,yBAAA,IAA6B,CAAC,WAAa,EAAA;AAC7C,UAAA,WAAA,GAAc,eAAe,IAAI,CAAA,CAAA;AAAA,mBACxB,WAAa,EAAA;AACtB,UAAc,WAAA,GAAA,WAAA;AAAA,YACZ,GAAA;AAAA,YACA,yBAAA;AAAA,WACF,CAAA;AAAA,SACK,MAAA;AACL,UAAA,WAAA,GAAc,CAAC,IAAI,CAAA,CAAA;AAAA,SACrB;AAAA,iBACS,cAAgB,EAAA;AACzB,QAAA,WAAA,GAAc,mBAAmB,IAAI,CAAA,CAAA;AAAA,OAChC,MAAA;AACL,QAAA,WAAA,GAAc,cAAc,IAAI,CAAA,CAAA;AAAA,OAClC;AAEA,MAAA,IAAI,gBAAgB,QAAU,EAAA;AAC5B,QAAA,WAAA,CAAY,WAAW,CAAA,CAAA;AAAA,OACzB;AAGA,MAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAW,GAAK,EAAA,IAAA,CAAA,CAAA;AAEhB,MAAA,IAAI,gBAAgB,QAAU,EAAA;AAC5B,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAA,iBAAA,CAAkB,KAAK,WAAW,CAAA,CAAA;AAAA,SACpC;AAAA,OACF;AAAA,KACF;AAAA,IACA;AAAA,MACE,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA,cAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,cAAA;AAAA,MACA,WAAA;AAAA,MACA,kBAAA;AAAA,MACA,aAAA;AAAA,MACA,WAAA;AAAA,MACA,iBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,aAAgB,GAAAA,iBAAA;AAAA,IACpB,CAAC,GAAuB,KAAA;AACtB,MAAA,MAAM,OAAO,cAAe,CAAA,cAAA,CAAA,CAAA;AAC5B,MAAI,IAAA,YAAA,CAAa,IAAI,CAAG,EAAA;AACtB,QAAA,IAAI,iBAAiB,GAAG,CAAA,IAAM,WAAe,IAAA,GAAA,CAAI,QAAQ,KAAQ,EAAA;AAG/D,UAAI,IAAA,GAAA,CAAI,QAAQ,KAAO,EAAA;AACrB,YAAA,GAAA,CAAI,cAAe,EAAA,CAAA;AAAA,WACrB;AACA,UAAA,iBAAA;AAAA,YACE,GAAA;AAAA,YACA,cAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA;AAAA,YACA,GAAA,CAAI,WAAW,GAAI,CAAA,OAAA;AAAA,WACrB,CAAA;AACA,UAAA,IAAI,gBAAkB,EAAA;AACpB,YAAA,UAAA,CAAW,OAAU,GAAA,cAAA,CAAA;AAAA,WACvB;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA;AAAA,MACE,cAAA;AAAA,MACA,cAAA;AAAA,MACA,gBAAA;AAAA,MACA,WAAA;AAAA,MACA,iBAAA;AAAA,MACA,gBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,wBAA2B,GAAAA,iBAAA;AAAA,IAC/B,CAAC,KAAoB,YAAyB,KAAA;AAC5C,MAAI,IAAA,gBAAA,IAAoB,IAAI,QAAU,EAAA;AACpC,QAAA,MAAM,OAAO,cAAe,CAAA,YAAA,CAAA,CAAA;AAC5B,QAAI,IAAA,YAAA,CAAa,IAAI,CAAG,EAAA;AACtB,UAAkB,iBAAA,CAAA,GAAA,EAAK,YAAc,EAAA,IAAA,EAAM,IAAI,CAAA,CAAA;AAAA,SACjD;AAAA,OACF;AAAA,KACF;AAAA,IACA,CAAC,gBAAkB,EAAA,cAAA,EAAgB,iBAAiB,CAAA;AAAA,GACtD,CAAA;AAEA,EAAA,MAAM,WAAc,GAAAA,iBAAA;AAAA,IAClB,CAAC,GAAoB,KAAA;AACnB,MAAA,MAAM,OAAO,cAAe,CAAA,cAAA,CAAA,CAAA;AAC5B,MAAA,IAAI,CAAC,gBAAA,IAAoB,YAAa,CAAA,IAAI,CAAG,EAAA;AAE3C,QAAA,GAAA,CAAI,cAAe,EAAA,CAAA;AACnB,QAAA,GAAA,CAAI,eAAgB,EAAA,CAAA;AACpB,QAAA,iBAAA;AAAA,UACE,GAAA;AAAA,UACA,cAAA;AAAA,UACA,IAAA;AAAA,UACA,GAAI,CAAA,QAAA;AAAA,UACJ,GAAA,CAAI,WAAW,GAAI,CAAA,OAAA;AAAA,SACrB,CAAA;AACA,QAAA,IAAI,gBAAkB,EAAA;AACpB,UAAA,UAAA,CAAW,OAAU,GAAA,cAAA,CAAA;AAAA,SACvB;AAAA,OAEF;AAAA,KACF;AAAA,IACA;AAAA,MACE,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,iBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,YAAe,GAAA;AAAA,IACnB,OAAS,EAAA,WAAA;AAAA,IACT,SAAW,EAAA,aAAA;AAAA,IACX,oBAAsB,EAAA,wBAAA;AAAA,GACxB,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,YAAA;AAAA,IACA,QAAA;AAAA,IACA,WAAA;AAAA,GACF,CAAA;AACF;;;;;"}

package/dist-cjs/packages/lab/src/common-hooks/useTypeahead.js

@@ -0,0 +1,76 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var keyUtils = require('./keyUtils.js');
+
+const useTypeahead = ({
+  disableTypeToSelect,
+  highlightedIdx,
+  highlightItemAtIndex,
+  typeToNavigate,
+  items,
+  applyIncrementalSearch = true
+}) => {
+  const keyDownTimer = React.useRef(null);
+  const searchChars = React.useRef("");
+  const startIdx = React.useRef(-1);
+  const applySearch = React.useCallback(
+    (intermediateSearch) => {
+      if (intermediateSearch || !applyIncrementalSearch) {
+        const regex = new RegExp(`^${searchChars.current}`, "i");
+        let idx = items.findIndex(
+          ({ label }, i) => i > startIdx.current && regex.test(label)
+        );
+        if (idx === -1) {
+          idx = items.findIndex(
+            ({ label }, i) => i <= startIdx.current && regex.test(label)
+          );
+        }
+        if (idx !== -1) {
+          highlightItemAtIndex(idx);
+        }
+      } else {
+        searchChars.current = "";
+        keyDownTimer.current = null;
+        startIdx.current = -1;
+      }
+    },
+    [applyIncrementalSearch, highlightItemAtIndex, items]
+  );
+  const handleKeyDown = React.useCallback(
+    (e) => {
+      const searchInProgress = startIdx.current !== -1;
+      if (keyUtils.isCharacterKey(e) || searchInProgress && e.key === keyUtils.Space) {
+        if (typeToNavigate) {
+          e.preventDefault();
+          e.stopPropagation();
+          if (startIdx.current === -1 || e.key === searchChars.current) {
+            startIdx.current = highlightedIdx;
+          }
+          if (keyDownTimer.current !== null) {
+            clearTimeout(keyDownTimer.current);
+            keyDownTimer.current = null;
+          }
+          if (e.key !== searchChars.current) {
+            searchChars.current += e.key;
+          }
+          if (applyIncrementalSearch) {
+            applySearch(true);
+          }
+          keyDownTimer.current = window.setTimeout(() => {
+            applySearch();
+          }, 100);
+        }
+      }
+    },
+    [typeToNavigate, applyIncrementalSearch, highlightedIdx, applySearch]
+  );
+  return {
+    onKeyDown: disableTypeToSelect ? void 0 : handleKeyDown
+  };
+};
+
+exports.useTypeahead = useTypeahead;
+//# sourceMappingURL=useTypeahead.js.map

package/dist-cjs/packages/lab/src/common-hooks/useTypeahead.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTypeahead.js","sources":["../src/common-hooks/useTypeahead.ts"],"sourcesContent":["import { useCallback, useRef } from \"react\";\nimport { isCharacterKey, Space } from \"./keyUtils\";\nimport { CollectionItem } from \"./collectionTypes\";\n\ninterface TypeaheadHookProps<Item> {\n  disableTypeToSelect?: boolean;\n  highlightedIdx: number;\n  highlightItemAtIndex: (idx: number) => void;\n  applyIncrementalSearch?: boolean;\n  typeToNavigate: boolean;\n  items: CollectionItem<Item>[];\n}\n\ninterface TypeaheadHookResult {\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\nexport const useTypeahead = <Item>({\n  disableTypeToSelect,\n  highlightedIdx,\n  highlightItemAtIndex,\n  typeToNavigate,\n  items,\n  applyIncrementalSearch = true,\n}: TypeaheadHookProps<Item>): TypeaheadHookResult => {\n  const keyDownTimer = useRef<number | null>(null);\n  const searchChars = useRef(\"\");\n  const startIdx = useRef(-1);\n\n  const applySearch = useCallback(\n    (intermediateSearch?: true | undefined) => {\n      if (intermediateSearch || !applyIncrementalSearch) {\n        const regex = new RegExp(`^${searchChars.current}`, \"i\");\n        let idx = items.findIndex(\n          ({ label }, i) => i > startIdx.current && regex.test(label!)\n        );\n        if (idx === -1) {\n          idx = items.findIndex(\n            ({ label }, i) => i <= startIdx.current && regex.test(label!)\n          );\n        }\n        if (idx !== -1) {\n          highlightItemAtIndex(idx);\n        }\n      } else {\n        searchChars.current = \"\";\n        keyDownTimer.current = null;\n        startIdx.current = -1;\n      }\n    },\n    [applyIncrementalSearch, highlightItemAtIndex, items]\n  );\n\n  const handleKeyDown = useCallback(\n    (e: React.KeyboardEvent) => {\n      const searchInProgress = startIdx.current !== -1;\n      if (isCharacterKey(e) || (searchInProgress && e.key === Space)) {\n        if (typeToNavigate) {\n          e.preventDefault();\n          e.stopPropagation();\n          // If we type the same key repeatedly, we cycle through the matches\n          if (startIdx.current === -1 || e.key === searchChars.current) {\n            startIdx.current = highlightedIdx;\n          }\n          if (keyDownTimer.current !== null) {\n            clearTimeout(keyDownTimer.current);\n            keyDownTimer.current = null;\n          }\n          if (e.key !== searchChars.current) {\n            searchChars.current += e.key;\n          }\n          if (applyIncrementalSearch) {\n            applySearch(true);\n          }\n          // keyDownTimer.current = window.setTimeout(applySearch, 100);\n          keyDownTimer.current = window.setTimeout(() => {\n            applySearch();\n          }, 100);\n        }\n      }\n    },\n    [typeToNavigate, applyIncrementalSearch, highlightedIdx, applySearch]\n  );\n\n  return {\n    onKeyDown: disableTypeToSelect ? undefined : handleKeyDown,\n  };\n};\n"],"names":["useRef","useCallback","isCharacterKey","Space"],"mappings":";;;;;;;AAiBO,MAAM,eAAe,CAAO;AAAA,EACjC,mBAAA;AAAA,EACA,cAAA;AAAA,EACA,oBAAA;AAAA,EACA,cAAA;AAAA,EACA,KAAA;AAAA,EACA,sBAAyB,GAAA,IAAA;AAC3B,CAAqD,KAAA;AACnD,EAAM,MAAA,YAAA,GAAeA,aAAsB,IAAI,CAAA,CAAA;AAC/C,EAAM,MAAA,WAAA,GAAcA,aAAO,EAAE,CAAA,CAAA;AAC7B,EAAM,MAAA,QAAA,GAAWA,aAAO,CAAE,CAAA,CAAA,CAAA;AAE1B,EAAA,MAAM,WAAc,GAAAC,iBAAA;AAAA,IAClB,CAAC,kBAA0C,KAAA;AACzC,MAAI,IAAA,kBAAA,IAAsB,CAAC,sBAAwB,EAAA;AACjD,QAAA,MAAM,QAAQ,IAAI,MAAA,CAAO,CAAI,CAAA,EAAA,WAAA,CAAY,WAAW,GAAG,CAAA,CAAA;AACvD,QAAA,IAAI,MAAM,KAAM,CAAA,SAAA;AAAA,UACd,CAAC,EAAE,KAAA,EAAS,EAAA,CAAA,KAAM,IAAI,QAAS,CAAA,OAAA,IAAW,KAAM,CAAA,IAAA,CAAK,KAAM,CAAA;AAAA,SAC7D,CAAA;AACA,QAAA,IAAI,QAAQ,CAAI,CAAA,EAAA;AACd,UAAA,GAAA,GAAM,KAAM,CAAA,SAAA;AAAA,YACV,CAAC,EAAE,KAAA,EAAS,EAAA,CAAA,KAAM,KAAK,QAAS,CAAA,OAAA,IAAW,KAAM,CAAA,IAAA,CAAK,KAAM,CAAA;AAAA,WAC9D,CAAA;AAAA,SACF;AACA,QAAA,IAAI,QAAQ,CAAI,CAAA,EAAA;AACd,UAAA,oBAAA,CAAqB,GAAG,CAAA,CAAA;AAAA,SAC1B;AAAA,OACK,MAAA;AACL,QAAA,WAAA,CAAY,OAAU,GAAA,EAAA,CAAA;AACtB,QAAA,YAAA,CAAa,OAAU,GAAA,IAAA,CAAA;AACvB,QAAA,QAAA,CAAS,OAAU,GAAA,CAAA,CAAA,CAAA;AAAA,OACrB;AAAA,KACF;AAAA,IACA,CAAC,sBAAwB,EAAA,oBAAA,EAAsB,KAAK,CAAA;AAAA,GACtD,CAAA;AAEA,EAAA,MAAM,aAAgB,GAAAA,iBAAA;AAAA,IACpB,CAAC,CAA2B,KAAA;AAC1B,MAAM,MAAA,gBAAA,GAAmB,SAAS,OAAY,KAAA,CAAA,CAAA,CAAA;AAC9C,MAAA,IAAIC,wBAAe,CAAC,CAAA,IAAM,gBAAoB,IAAA,CAAA,CAAE,QAAQC,cAAQ,EAAA;AAC9D,QAAA,IAAI,cAAgB,EAAA;AAClB,UAAA,CAAA,CAAE,cAAe,EAAA,CAAA;AACjB,UAAA,CAAA,CAAE,eAAgB,EAAA,CAAA;AAElB,UAAA,IAAI,SAAS,OAAY,KAAA,CAAA,CAAA,IAAM,CAAE,CAAA,GAAA,KAAQ,YAAY,OAAS,EAAA;AAC5D,YAAA,QAAA,CAAS,OAAU,GAAA,cAAA,CAAA;AAAA,WACrB;AACA,UAAI,IAAA,YAAA,CAAa,YAAY,IAAM,EAAA;AACjC,YAAA,YAAA,CAAa,aAAa,OAAO,CAAA,CAAA;AACjC,YAAA,YAAA,CAAa,OAAU,GAAA,IAAA,CAAA;AAAA,WACzB;AACA,UAAI,IAAA,CAAA,CAAE,GAAQ,KAAA,WAAA,CAAY,OAAS,EAAA;AACjC,YAAA,WAAA,CAAY,WAAW,CAAE,CAAA,GAAA,CAAA;AAAA,WAC3B;AACA,UAAA,IAAI,sBAAwB,EAAA;AAC1B,YAAA,WAAA,CAAY,IAAI,CAAA,CAAA;AAAA,WAClB;AAEA,UAAa,YAAA,CAAA,OAAA,GAAU,MAAO,CAAA,UAAA,CAAW,MAAM;AAC7C,YAAY,WAAA,EAAA,CAAA;AAAA,aACX,GAAG,CAAA,CAAA;AAAA,SACR;AAAA,OACF;AAAA,KACF;AAAA,IACA,CAAC,cAAA,EAAgB,sBAAwB,EAAA,cAAA,EAAgB,WAAW,CAAA;AAAA,GACtE,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,SAAA,EAAW,sBAAsB,KAAY,CAAA,GAAA,aAAA;AAAA,GAC/C,CAAA;AACF;;;;"}