@salt-ds/lab 1.0.0-alpha.1 → 1.0.0-alpha.11

package/dist-cjs/combo-box-deprecated/internal/useMultiSelectComboBox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMultiSelectComboBox.js","sources":["../src/combo-box-deprecated/internal/useMultiSelectComboBox.ts"],"sourcesContent":["import {\n  useControlled,\n  useForkRef,\n  useId,\n  useIsFocusVisible,\n  useIsomorphicLayoutEffect,\n} from \"@salt-ds/core\";\nimport {\n  ChangeEvent,\n  FocusEvent,\n  KeyboardEvent,\n  KeyboardEventHandler,\n  MouseEvent,\n  RefObject,\n  SyntheticEvent,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n} from \"react\";\nimport { useList } from \"../../list-deprecated\";\nimport { ExpandButtonProps, useTokenizedInput } from \"../../tokenized-input\";\nimport { defaultItemToString } from \"../../tokenized-input/internal/defaultItemToString\";\nimport { usePrevious } from \"@salt-ds/core\";\nimport { getDefaultFilter, getDefaultFilterRegex } from \"../filterHelpers\";\nimport { MultiSelectComboBoxProps } from \"./MultiSelectComboBox\";\nimport { isToggleList, usePopperStatus } from \"./usePopperStatus\";\n\nconst REQUIRE_PREV_HIGHLIGHT = [\"ArrowUp\", \"ArrowDown\", \"PageUp\", \"PageDown\"];\n\nexport type UseMultiSelectComboBoxProps<Item> = Omit<\n  MultiSelectComboBoxProps<Item>,\n  \"inputRef\" | \"listContext\" | \"inputHelpers\" | \"inputProps\" | \"listProps\"\n> & { expandButtonRef: RefObject<HTMLElement> };\n\nexport const useMultiSelectComboBox = <Item>(\n  props: Omit<UseMultiSelectComboBoxProps<Item>, \"rootRef\" | \"classes\">\n) => {\n  // Deconstruct valid props for List, everything else will be passed to `useTokenizedInput` using `restProps`\n  const {\n    allowFreeText,\n    displayedItemCount,\n    virtualized,\n    disabled,\n    expandButtonRef,\n    onBlur,\n    onFocus,\n    onChange,\n    onSelect,\n    onInputChange,\n    onInputFocus,\n    onInputBlur,\n    onInputSelect,\n    id: idProp,\n    source: sourceProp,\n    selectedItem: selectedItemProp,\n    inputValue: inputValueProp,\n    initialOpen,\n    initialSelectedItem: initialSelectedItems,\n    \"aria-labelledby\": ariaLabelledBy,\n    getFilterRegex = getDefaultFilterRegex,\n    itemToString = defaultItemToString,\n    stringToItem: stringToItemProp = (_: any, value: string) => value.trim(),\n    InputProps = {\n      onBlur,\n      onFocus,\n      onInputBlur,\n      onInputFocus,\n      onInputChange,\n      onInputSelect,\n    },\n    ListProps = {},\n    ...restProps\n  } = props;\n\n  const id = useId(idProp);\n  const inputId = `${id}-input`;\n  const listId = `${id}-list`;\n\n  const [inputValue, setInputValue] = useControlled({\n    controlled: inputValueProp,\n    default: \"\",\n    name: \"MultiSelectComboBox\",\n    state: \"inputValue\",\n  });\n\n  const { isOpen: isListOpen, notifyPopper } = usePopperStatus({\n    initialOpen,\n    isMultiSelect: true,\n  });\n\n  const [selectionChanged, setSelectionChanged] = useState(false);\n  const inputBlurTimeout = useRef<number>(null);\n\n  const [allowAnnouncement, setAllowAnnouncement] = useState(false);\n\n  const labels = useMemo(\n    () => sourceProp.map(itemToString),\n    [sourceProp, itemToString]\n  );\n\n  const source = useMemo(() => {\n    if (inputValue && inputValue.trim().length) {\n      const itemFilter = getDefaultFilter(inputValue, getFilterRegex);\n      return sourceProp.filter((item: Item) => itemFilter(itemToString(item)));\n    }\n    return sourceProp;\n  }, [inputValue, sourceProp, getFilterRegex, itemToString]);\n\n  const itemTextHighlightPattern = useMemo(\n    () =>\n      inputValue && inputValue.trim().length\n        ? getFilterRegex(inputValue)\n        : undefined,\n    [inputValue, getFilterRegex]\n  );\n\n  const {\n    focusedRef,\n    listProps,\n    state: listState,\n    helpers: listHelpers,\n  } = useList<Item, \"multiple\">({\n    ...ListProps,\n    source,\n    disabled,\n    virtualized,\n    itemToString,\n    displayedItemCount,\n    onChange,\n    onSelect,\n    id: listId,\n    disableFocus: true,\n    disableMouseDown: true,\n    selectionVariant: \"multiple\",\n    initialSelectedItem: initialSelectedItems,\n    selectedItem: selectedItemProp,\n    \"aria-labelledby\": ariaLabelledBy,\n  });\n\n  const { \"aria-activedescendant\": ariaActiveDescendant, ...restListProps } =\n    listProps;\n  const { selectedItem } = listState;\n  const [quickSelection, setQuickSelection] = useState(false);\n  const {\n    isFocusVisibleRef,\n    onFocus: handleFocusVisible,\n    onBlur: handleBlurVisible,\n    ref: focusVisibleRef,\n  } = useIsFocusVisible();\n  const selectedItems = selectedItem as Item[];\n  const {\n    setSelectedItem: setSelectedItems,\n    setHighlightedIndex: setHighlightedListIndex,\n  } = listHelpers;\n\n  const handleInputFocus = (event: FocusEvent<HTMLInputElement>) => {\n    handleFocusVisible(event);\n    if (isFocusVisibleRef.current) {\n      listHelpers.setFocusVisible(true);\n    }\n\n    if (InputProps.onInputFocus) {\n      InputProps.onInputFocus(event);\n    }\n\n    notifyPopper(event);\n  };\n\n  const handleInputBlur = (\n    event: FocusEvent<HTMLDivElement | HTMLInputElement>\n  ) => {\n    handleBlurVisible();\n    setAllowAnnouncement(false);\n    setInputValue(\"\");\n\n    if (restListProps.onBlur) {\n      restListProps.onBlur(event);\n    }\n\n    if (InputProps.onInputBlur) {\n      InputProps.onInputBlur(event as FocusEvent<HTMLInputElement>);\n    }\n\n    notifyPopper(event);\n  };\n\n  const handleInputChange = (event: ChangeEvent<HTMLInputElement>) => {\n    setInputValue(event.target.value);\n\n    setQuickSelection(event.target.value.length > 0 && !allowFreeText);\n\n    if (InputProps.onInputChange) {\n      InputProps.onInputChange(event);\n    }\n  };\n\n  const handleItemsChange = (newItems: Item[] | undefined) => {\n    const uniqueItems = Array.from(new Set(newItems));\n    setSelectedItems(uniqueItems);\n    onChange && onChange(null as unknown as ChangeEvent, uniqueItems);\n  };\n\n  const handleInputSelect = (event: SyntheticEvent<HTMLInputElement>) => {\n    event.persist();\n    setSelectionChanged(true);\n\n    if (InputProps.onInputSelect) {\n      InputProps.onInputSelect(event);\n    }\n  };\n\n  const handleClear = () => {\n    setSelectedItems([]);\n  };\n\n  const stringToItem = (selected: Item[], value: string): Item | null => {\n    const trimmed = value.trim();\n    const item = stringToItemProp(selected, trimmed);\n    const isSelected = selected.map(itemToString).indexOf(trimmed) !== -1;\n\n    // Either allow free text item OR the item has to be in the source list\n    return !isSelected && (allowFreeText || labels.indexOf(trimmed) !== -1)\n      ? (item as Item)\n      : null;\n  };\n\n  // Reuse selectItem from list state for a controlled version of tokenized input\n  const {\n    inputRef,\n    inputProps,\n    state: inputState,\n    helpers: inputHelpers,\n  } = useTokenizedInput({\n    ...restProps,\n    ...InputProps,\n    disabled,\n    itemToString,\n    stringToItem,\n    selectedItems,\n    initialSelectedItems,\n    onInputFocus: handleInputFocus,\n    onInputBlur: handleInputBlur,\n    onInputChange: handleInputChange,\n    onInputSelect: handleInputSelect,\n    onChange: handleItemsChange,\n    onClear: handleClear,\n    onKeyDown: InputProps.onKeyDown as KeyboardEventHandler<\n      HTMLInputElement | HTMLButtonElement\n    >,\n  });\n\n  const handleFocusVisibleRef = useForkRef(focusVisibleRef, focusedRef);\n  const handleInputRef = useForkRef(inputRef, handleFocusVisibleRef);\n\n  const { setHighlightedIndex: setHighlightedPillIndex } = inputHelpers;\n\n  // Reset highlight when list closes\n  useEffect(() => {\n    if (!isListOpen) {\n      setHighlightedListIndex(undefined);\n      setQuickSelection(false);\n    }\n  }, [isListOpen, setHighlightedListIndex, setQuickSelection]);\n\n  const previousSelectedItems = usePrevious(selectedItems);\n\n  // Reset list highlight when selectItems change\n  useIsomorphicLayoutEffect(() => {\n    if (\n      selectedItems.some(\n        (item) => !(previousSelectedItems || []).includes(item)\n      )\n    ) {\n      setInputValue(\"\");\n    }\n\n    if (!selectedItems.length) {\n      setHighlightedListIndex(undefined);\n    }\n  }, [\n    selectedItems,\n    previousSelectedItems,\n    setInputValue,\n    setHighlightedListIndex,\n  ]);\n\n  // Remove highlight from list if a pill is highlighted\n  useEffect(() => {\n    if (\n      inputState.highlightedIndex != null &&\n      inputState.highlightedIndex >= 0\n    ) {\n      setHighlightedListIndex(undefined);\n      setQuickSelection(false);\n    }\n  }, [inputState.highlightedIndex, setHighlightedListIndex, setQuickSelection]);\n\n  const highlightedIndex = listState && listState.highlightedIndex;\n\n  // Remove highlight from pills if a list item is highlighted\n  useEffect(() => {\n    if (highlightedIndex != null && highlightedIndex >= 0) {\n      setHighlightedPillIndex(undefined);\n    }\n  }, [highlightedIndex, setHighlightedPillIndex]);\n\n  // Keep highlighted index in sync with the filtered source\n  useEffect(() => {\n    setHighlightedListIndex(undefined);\n  }, [source, setHighlightedListIndex]);\n\n  const handleFirstItemSelection = (event: KeyboardEvent | ChangeEvent) => {\n    if (\n      !allowFreeText &&\n      (event as KeyboardEvent).key === \"Enter\" &&\n      quickSelection\n    ) {\n      const newItem = source[0];\n      const newSelectedItems =\n        selectedItems.indexOf(newItem) === -1\n          ? selectedItems.concat(source.slice(0, 1))\n          : selectedItems.filter((item) => item !== newItem);\n      setSelectedItems(newSelectedItems);\n      onSelect && onSelect(event, newItem);\n      onChange && onChange(event as ChangeEvent, newSelectedItems);\n    }\n  };\n\n  const handleListOpenKeyDown = (event: KeyboardEvent<HTMLDivElement>) => {\n    if (\"Escape\" === event.key && inputProps.expanded) {\n      setTimeout(() => {\n        if (expandButtonRef.current) {\n          expandButtonRef.current.focus();\n        }\n      }, 250);\n    }\n\n    handleFirstItemSelection(event);\n\n    if (\n      \"Home\" !== event.key &&\n      \"End\" !== event.key &&\n      !(\" \" === event.key && !event.ctrlKey)\n    ) {\n      if (restListProps.onKeyDown) {\n        restListProps.onKeyDown(event);\n      }\n      setSelectionChanged(false);\n    }\n  };\n\n  const handleInputKeyDown = (\n    event: KeyboardEvent<HTMLInputElement | HTMLButtonElement | HTMLDivElement>\n  ) => {\n    if (\"Escape\" === event.key) {\n      setInputValue(\"\");\n      setHighlightedListIndex(undefined);\n    }\n\n    // Space key clashes with the remove action of TokenizedInput\n    // For combo box, pressing a space key should just add a space\n    if (\" \" === event.key && !event.ctrlKey) {\n      setHighlightedPillIndex(undefined);\n    } else {\n      if (inputProps.onKeyDown) {\n        inputProps.onKeyDown(\n          event as KeyboardEvent<HTMLInputElement | HTMLButtonElement>\n        );\n      }\n    }\n\n    if (\n      !isToggleList(event) &&\n      listState.highlightedIndex == null &&\n      REQUIRE_PREV_HIGHLIGHT.indexOf(event.key) !== -1\n    ) {\n      event.preventDefault();\n      // Initialize list highlight if there's no previous value\n      setHighlightedListIndex(\n        Math.min(quickSelection ? 1 : 0, source.length - 1)\n      );\n      setQuickSelection(false);\n      setSelectionChanged(false);\n    } else if (isListOpen) {\n      handleListOpenKeyDown(event as KeyboardEvent<HTMLDivElement>);\n    }\n\n    // Don't announce for deleting values\n    setAllowAnnouncement(\"Backspace\" !== event.key);\n    notifyPopper(event);\n  };\n\n  const handleListClick = (event: MouseEvent<HTMLDivElement>) => {\n    clearTimeout(\n      inputBlurTimeout.current == null ? undefined : inputBlurTimeout.current\n    );\n    const inputEl = inputRef && (inputRef as RefObject<HTMLElement>).current;\n    if (inputEl) {\n      inputEl.focus();\n    }\n\n    if (restListProps.onClick) {\n      restListProps.onClick(event);\n    }\n  };\n\n  const mergedInputProps = {\n    ...inputProps.InputProps,\n    inputProps: {\n      ...(inputProps.InputProps || {}).inputProps,\n      role: \"textbox\",\n      \"aria-roledescription\": \"MultiSelect Combobox\",\n    },\n  };\n\n  if (ariaActiveDescendant && !selectionChanged) {\n    // either null or undefined will prevent tokenized-input from\n    // setting active-descendant based on pill selection.\n    mergedInputProps.inputProps[\"aria-activedescendant\"] = ariaActiveDescendant;\n  }\n\n  const expandButtonProps = {\n    accessibleText: undefined,\n    role: \"button\",\n    \"aria-roledescription\": \"Expand combobox button\",\n    \"aria-labelledby\": [ariaLabelledBy, `${inputId}-input`]\n      .filter(Boolean)\n      .join(\" \"),\n  } as ExpandButtonProps;\n\n  return {\n    inputHelpers,\n    inputRef: handleInputRef,\n    listContext: {\n      state: listState,\n      helpers: listHelpers,\n    },\n    inputProps: {\n      ...inputProps,\n      selectedItems,\n      allowAnnouncement,\n      id: inputId,\n      value: inputValue,\n      ExpandButtonProps: expandButtonProps,\n      InputProps: mergedInputProps,\n      onKeyDown: handleInputKeyDown,\n    },\n    listProps: {\n      ...restListProps,\n      source,\n      itemToString,\n      itemTextHighlightPattern,\n      onClick: handleListClick,\n      isListOpen: isListOpen && Boolean(source.length),\n    },\n  };\n};\n"],"names":["getDefaultFilterRegex","defaultItemToString","useId","useControlled","usePopperStatus","useState","useRef","useMemo","getDefaultFilter","useList","useIsFocusVisible","useTokenizedInput","useForkRef","useEffect","usePrevious","useIsomorphicLayoutEffect","isToggleList"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4BA,MAAM,sBAAyB,GAAA,CAAC,SAAW,EAAA,WAAA,EAAa,UAAU,UAAU,CAAA,CAAA;AAO/D,MAAA,sBAAA,GAAyB,CACpC,KACG,KAAA;AAEH,EAAM,MAAA;AAAA,IACJ,aAAA;AAAA,IACA,kBAAA;AAAA,IACA,WAAA;AAAA,IACA,QAAA;AAAA,IACA,eAAA;AAAA,IACA,MAAA;AAAA,IACA,OAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA,aAAA;AAAA,IACA,YAAA;AAAA,IACA,WAAA;AAAA,IACA,aAAA;AAAA,IACA,EAAI,EAAA,MAAA;AAAA,IACJ,MAAQ,EAAA,UAAA;AAAA,IACR,YAAc,EAAA,gBAAA;AAAA,IACd,UAAY,EAAA,cAAA;AAAA,IACZ,WAAA;AAAA,IACA,mBAAqB,EAAA,oBAAA;AAAA,IACrB,iBAAmB,EAAA,cAAA;AAAA,IACnB,cAAiB,GAAAA,mCAAA;AAAA,IACjB,YAAe,GAAAC,uCAAA;AAAA,IACf,cAAc,gBAAmB,GAAA,CAAC,CAAQ,EAAA,KAAA,KAAkB,MAAM,IAAK,EAAA;AAAA,IACvE,UAAa,GAAA;AAAA,MACX,MAAA;AAAA,MACA,OAAA;AAAA,MACA,WAAA;AAAA,MACA,YAAA;AAAA,MACA,aAAA;AAAA,MACA,aAAA;AAAA,KACF;AAAA,IACA,YAAY,EAAC;AAAA,IACV,GAAA,SAAA;AAAA,GACD,GAAA,KAAA,CAAA;AAEJ,EAAM,MAAA,EAAA,GAAKC,WAAM,MAAM,CAAA,CAAA;AACvB,EAAA,MAAM,UAAU,CAAG,EAAA,EAAA,CAAA,MAAA,CAAA,CAAA;AACnB,EAAA,MAAM,SAAS,CAAG,EAAA,EAAA,CAAA,KAAA,CAAA,CAAA;AAElB,EAAA,MAAM,CAAC,UAAA,EAAY,aAAa,CAAA,GAAIC,kBAAc,CAAA;AAAA,IAChD,UAAY,EAAA,cAAA;AAAA,IACZ,OAAS,EAAA,EAAA;AAAA,IACT,IAAM,EAAA,qBAAA;AAAA,IACN,KAAO,EAAA,YAAA;AAAA,GACR,CAAA,CAAA;AAED,EAAA,MAAM,EAAE,MAAA,EAAQ,UAAY,EAAA,YAAA,KAAiBC,+BAAgB,CAAA;AAAA,IAC3D,WAAA;AAAA,IACA,aAAe,EAAA,IAAA;AAAA,GAChB,CAAA,CAAA;AAED,EAAA,MAAM,CAAC,gBAAA,EAAkB,mBAAmB,CAAA,GAAIC,eAAS,KAAK,CAAA,CAAA;AAC9D,EAAM,MAAA,gBAAA,GAAmBC,aAAe,IAAI,CAAA,CAAA;AAE5C,EAAA,MAAM,CAAC,iBAAA,EAAmB,oBAAoB,CAAA,GAAID,eAAS,KAAK,CAAA,CAAA;AAEhE,EAAA,MAAM,MAAS,GAAAE,aAAA;AAAA,IACb,MAAM,UAAW,CAAA,GAAA,CAAI,YAAY,CAAA;AAAA,IACjC,CAAC,YAAY,YAAY,CAAA;AAAA,GAC3B,CAAA;AAEA,EAAM,MAAA,MAAA,GAASA,cAAQ,MAAM;AAC3B,IAAA,IAAI,UAAc,IAAA,UAAA,CAAW,IAAK,EAAA,CAAE,MAAQ,EAAA;AAC1C,MAAM,MAAA,UAAA,GAAaC,8BAAiB,CAAA,UAAA,EAAY,cAAc,CAAA,CAAA;AAC9D,MAAO,OAAA,UAAA,CAAW,OAAO,CAAC,IAAA,KAAe,WAAW,YAAa,CAAA,IAAI,CAAC,CAAC,CAAA,CAAA;AAAA,KACzE;AACA,IAAO,OAAA,UAAA,CAAA;AAAA,KACN,CAAC,UAAA,EAAY,UAAY,EAAA,cAAA,EAAgB,YAAY,CAAC,CAAA,CAAA;AAEzD,EAAA,MAAM,wBAA2B,GAAAD,aAAA;AAAA,IAC/B,MACE,cAAc,UAAW,CAAA,IAAA,GAAO,MAC5B,GAAA,cAAA,CAAe,UAAU,CACzB,GAAA,KAAA,CAAA;AAAA,IACN,CAAC,YAAY,cAAc,CAAA;AAAA,GAC7B,CAAA;AAEA,EAAM,MAAA;AAAA,IACJ,UAAA;AAAA,IACA,SAAA;AAAA,IACA,KAAO,EAAA,SAAA;AAAA,IACP,OAAS,EAAA,WAAA;AAAA,MACPE,eAA0B,CAAA;AAAA,IAC5B,GAAG,SAAA;AAAA,IACH,MAAA;AAAA,IACA,QAAA;AAAA,IACA,WAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA,EAAI,EAAA,MAAA;AAAA,IACJ,YAAc,EAAA,IAAA;AAAA,IACd,gBAAkB,EAAA,IAAA;AAAA,IAClB,gBAAkB,EAAA,UAAA;AAAA,IAClB,mBAAqB,EAAA,oBAAA;AAAA,IACrB,YAAc,EAAA,gBAAA;AAAA,IACd,iBAAmB,EAAA,cAAA;AAAA,GACpB,CAAA,CAAA;AAED,EAAA,MAAM,EAAE,uBAAA,EAAyB,oBAAyB,EAAA,GAAA,aAAA,EACxD,GAAA,SAAA,CAAA;AACF,EAAM,MAAA,EAAE,cAAiB,GAAA,SAAA,CAAA;AACzB,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAiB,CAAA,GAAIJ,eAAS,KAAK,CAAA,CAAA;AAC1D,EAAM,MAAA;AAAA,IACJ,iBAAA;AAAA,IACA,OAAS,EAAA,kBAAA;AAAA,IACT,MAAQ,EAAA,iBAAA;AAAA,IACR,GAAK,EAAA,eAAA;AAAA,MACHK,sBAAkB,EAAA,CAAA;AACtB,EAAA,MAAM,aAAgB,GAAA,YAAA,CAAA;AACtB,EAAM,MAAA;AAAA,IACJ,eAAiB,EAAA,gBAAA;AAAA,IACjB,mBAAqB,EAAA,uBAAA;AAAA,GACnB,GAAA,WAAA,CAAA;AAEJ,EAAM,MAAA,gBAAA,GAAmB,CAAC,KAAwC,KAAA;AAChE,IAAA,kBAAA,CAAmB,KAAK,CAAA,CAAA;AACxB,IAAA,IAAI,kBAAkB,OAAS,EAAA;AAC7B,MAAA,WAAA,CAAY,gBAAgB,IAAI,CAAA,CAAA;AAAA,KAClC;AAEA,IAAA,IAAI,WAAW,YAAc,EAAA;AAC3B,MAAA,UAAA,CAAW,aAAa,KAAK,CAAA,CAAA;AAAA,KAC/B;AAEA,IAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAAA,GACpB,CAAA;AAEA,EAAM,MAAA,eAAA,GAAkB,CACtB,KACG,KAAA;AACH,IAAkB,iBAAA,EAAA,CAAA;AAClB,IAAA,oBAAA,CAAqB,KAAK,CAAA,CAAA;AAC1B,IAAA,aAAA,CAAc,EAAE,CAAA,CAAA;AAEhB,IAAA,IAAI,cAAc,MAAQ,EAAA;AACxB,MAAA,aAAA,CAAc,OAAO,KAAK,CAAA,CAAA;AAAA,KAC5B;AAEA,IAAA,IAAI,WAAW,WAAa,EAAA;AAC1B,MAAA,UAAA,CAAW,YAAY,KAAqC,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAAA,GACpB,CAAA;AAEA,EAAM,MAAA,iBAAA,GAAoB,CAAC,KAAyC,KAAA;AAClE,IAAc,aAAA,CAAA,KAAA,CAAM,OAAO,KAAK,CAAA,CAAA;AAEhC,IAAA,iBAAA,CAAkB,MAAM,MAAO,CAAA,KAAA,CAAM,MAAS,GAAA,CAAA,IAAK,CAAC,aAAa,CAAA,CAAA;AAEjE,IAAA,IAAI,WAAW,aAAe,EAAA;AAC5B,MAAA,UAAA,CAAW,cAAc,KAAK,CAAA,CAAA;AAAA,KAChC;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,iBAAA,GAAoB,CAAC,QAAiC,KAAA;AAC1D,IAAA,MAAM,cAAc,KAAM,CAAA,IAAA,CAAK,IAAI,GAAA,CAAI,QAAQ,CAAC,CAAA,CAAA;AAChD,IAAA,gBAAA,CAAiB,WAAW,CAAA,CAAA;AAC5B,IAAY,QAAA,IAAA,QAAA,CAAS,MAAgC,WAAW,CAAA,CAAA;AAAA,GAClE,CAAA;AAEA,EAAM,MAAA,iBAAA,GAAoB,CAAC,KAA4C,KAAA;AACrE,IAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AACd,IAAA,mBAAA,CAAoB,IAAI,CAAA,CAAA;AAExB,IAAA,IAAI,WAAW,aAAe,EAAA;AAC5B,MAAA,UAAA,CAAW,cAAc,KAAK,CAAA,CAAA;AAAA,KAChC;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,cAAc,MAAM;AACxB,IAAA,gBAAA,CAAiB,EAAE,CAAA,CAAA;AAAA,GACrB,CAAA;AAEA,EAAM,MAAA,YAAA,GAAe,CAAC,QAAA,EAAkB,KAA+B,KAAA;AACrE,IAAM,MAAA,OAAA,GAAU,MAAM,IAAK,EAAA,CAAA;AAC3B,IAAM,MAAA,IAAA,GAAO,gBAAiB,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAC/C,IAAA,MAAM,aAAa,QAAS,CAAA,GAAA,CAAI,YAAY,CAAE,CAAA,OAAA,CAAQ,OAAO,CAAM,KAAA,CAAA,CAAA,CAAA;AAGnE,IAAO,OAAA,CAAC,eAAe,aAAiB,IAAA,MAAA,CAAO,QAAQ,OAAO,CAAA,KAAM,MAC/D,IACD,GAAA,IAAA,CAAA;AAAA,GACN,CAAA;AAGA,EAAM,MAAA;AAAA,IACJ,QAAA;AAAA,IACA,UAAA;AAAA,IACA,KAAO,EAAA,UAAA;AAAA,IACP,OAAS,EAAA,YAAA;AAAA,MACPC,mCAAkB,CAAA;AAAA,IACpB,GAAG,SAAA;AAAA,IACH,GAAG,UAAA;AAAA,IACH,QAAA;AAAA,IACA,YAAA;AAAA,IACA,YAAA;AAAA,IACA,aAAA;AAAA,IACA,oBAAA;AAAA,IACA,YAAc,EAAA,gBAAA;AAAA,IACd,WAAa,EAAA,eAAA;AAAA,IACb,aAAe,EAAA,iBAAA;AAAA,IACf,aAAe,EAAA,iBAAA;AAAA,IACf,QAAU,EAAA,iBAAA;AAAA,IACV,OAAS,EAAA,WAAA;AAAA,IACT,WAAW,UAAW,CAAA,SAAA;AAAA,GAGvB,CAAA,CAAA;AAED,EAAM,MAAA,qBAAA,GAAwBC,eAAW,CAAA,eAAA,EAAiB,UAAU,CAAA,CAAA;AACpE,EAAM,MAAA,cAAA,GAAiBA,eAAW,CAAA,QAAA,EAAU,qBAAqB,CAAA,CAAA;AAEjE,EAAM,MAAA,EAAE,mBAAqB,EAAA,uBAAA,EAA4B,GAAA,YAAA,CAAA;AAGzD,EAAAC,eAAA,CAAU,MAAM;AACd,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AACjC,MAAA,iBAAA,CAAkB,KAAK,CAAA,CAAA;AAAA,KACzB;AAAA,GACC,EAAA,CAAC,UAAY,EAAA,uBAAA,EAAyB,iBAAiB,CAAC,CAAA,CAAA;AAE3D,EAAM,MAAA,qBAAA,GAAwBC,iBAAY,aAAa,CAAA,CAAA;AAGvD,EAAAC,8BAAA,CAA0B,MAAM;AAC9B,IAAA,IACE,aAAc,CAAA,IAAA;AAAA,MACZ,CAAC,IAAS,KAAA,CAAA,CAAE,yBAAyB,EAAC,EAAG,SAAS,IAAI,CAAA;AAAA,KAExD,EAAA;AACA,MAAA,aAAA,CAAc,EAAE,CAAA,CAAA;AAAA,KAClB;AAEA,IAAI,IAAA,CAAC,cAAc,MAAQ,EAAA;AACzB,MAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AAAA,KACnC;AAAA,GACC,EAAA;AAAA,IACD,aAAA;AAAA,IACA,qBAAA;AAAA,IACA,aAAA;AAAA,IACA,uBAAA;AAAA,GACD,CAAA,CAAA;AAGD,EAAAF,eAAA,CAAU,MAAM;AACd,IAAA,IACE,UAAW,CAAA,gBAAA,IAAoB,IAC/B,IAAA,UAAA,CAAW,oBAAoB,CAC/B,EAAA;AACA,MAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AACjC,MAAA,iBAAA,CAAkB,KAAK,CAAA,CAAA;AAAA,KACzB;AAAA,KACC,CAAC,UAAA,CAAW,gBAAkB,EAAA,uBAAA,EAAyB,iBAAiB,CAAC,CAAA,CAAA;AAE5E,EAAM,MAAA,gBAAA,GAAmB,aAAa,SAAU,CAAA,gBAAA,CAAA;AAGhD,EAAAA,eAAA,CAAU,MAAM;AACd,IAAI,IAAA,gBAAA,IAAoB,IAAQ,IAAA,gBAAA,IAAoB,CAAG,EAAA;AACrD,MAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AAAA,KACnC;AAAA,GACC,EAAA,CAAC,gBAAkB,EAAA,uBAAuB,CAAC,CAAA,CAAA;AAG9C,EAAAA,eAAA,CAAU,MAAM;AACd,IAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AAAA,GAChC,EAAA,CAAC,MAAQ,EAAA,uBAAuB,CAAC,CAAA,CAAA;AAEpC,EAAM,MAAA,wBAAA,GAA2B,CAAC,KAAuC,KAAA;AACvE,IAAA,IACE,CAAC,aAAA,IACA,KAAwB,CAAA,GAAA,KAAQ,WACjC,cACA,EAAA;AACA,MAAA,MAAM,UAAU,MAAO,CAAA,CAAA,CAAA,CAAA;AACvB,MAAA,MAAM,mBACJ,aAAc,CAAA,OAAA,CAAQ,OAAO,CAAM,KAAA,CAAA,CAAA,GAC/B,cAAc,MAAO,CAAA,MAAA,CAAO,MAAM,CAAG,EAAA,CAAC,CAAC,CACvC,GAAA,aAAA,CAAc,OAAO,CAAC,IAAA,KAAS,SAAS,OAAO,CAAA,CAAA;AACrD,MAAA,gBAAA,CAAiB,gBAAgB,CAAA,CAAA;AACjC,MAAY,QAAA,IAAA,QAAA,CAAS,OAAO,OAAO,CAAA,CAAA;AACnC,MAAY,QAAA,IAAA,QAAA,CAAS,OAAsB,gBAAgB,CAAA,CAAA;AAAA,KAC7D;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,qBAAA,GAAwB,CAAC,KAAyC,KAAA;AACtE,IAAA,IAAI,QAAa,KAAA,KAAA,CAAM,GAAO,IAAA,UAAA,CAAW,QAAU,EAAA;AACjD,MAAA,UAAA,CAAW,MAAM;AACf,QAAA,IAAI,gBAAgB,OAAS,EAAA;AAC3B,UAAA,eAAA,CAAgB,QAAQ,KAAM,EAAA,CAAA;AAAA,SAChC;AAAA,SACC,GAAG,CAAA,CAAA;AAAA,KACR;AAEA,IAAA,wBAAA,CAAyB,KAAK,CAAA,CAAA;AAE9B,IAAA,IACE,MAAW,KAAA,KAAA,CAAM,GACjB,IAAA,KAAA,KAAU,KAAM,CAAA,GAAA,IAChB,EAAE,GAAA,KAAQ,KAAM,CAAA,GAAA,IAAO,CAAC,KAAA,CAAM,OAC9B,CAAA,EAAA;AACA,MAAA,IAAI,cAAc,SAAW,EAAA;AAC3B,QAAA,aAAA,CAAc,UAAU,KAAK,CAAA,CAAA;AAAA,OAC/B;AACA,MAAA,mBAAA,CAAoB,KAAK,CAAA,CAAA;AAAA,KAC3B;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,kBAAA,GAAqB,CACzB,KACG,KAAA;AACH,IAAI,IAAA,QAAA,KAAa,MAAM,GAAK,EAAA;AAC1B,MAAA,aAAA,CAAc,EAAE,CAAA,CAAA;AAChB,MAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AAAA,KACnC;AAIA,IAAA,IAAI,GAAQ,KAAA,KAAA,CAAM,GAAO,IAAA,CAAC,MAAM,OAAS,EAAA;AACvC,MAAA,uBAAA,CAAwB,KAAS,CAAA,CAAA,CAAA;AAAA,KAC5B,MAAA;AACL,MAAA,IAAI,WAAW,SAAW,EAAA;AACxB,QAAW,UAAA,CAAA,SAAA;AAAA,UACT,KAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,IACE,CAACG,4BAAA,CAAa,KAAK,CAAA,IACnB,SAAU,CAAA,gBAAA,IAAoB,IAC9B,IAAA,sBAAA,CAAuB,OAAQ,CAAA,KAAA,CAAM,GAAG,CAAA,KAAM,CAC9C,CAAA,EAAA;AACA,MAAA,KAAA,CAAM,cAAe,EAAA,CAAA;AAErB,MAAA,uBAAA;AAAA,QACE,KAAK,GAAI,CAAA,cAAA,GAAiB,IAAI,CAAG,EAAA,MAAA,CAAO,SAAS,CAAC,CAAA;AAAA,OACpD,CAAA;AACA,MAAA,iBAAA,CAAkB,KAAK,CAAA,CAAA;AACvB,MAAA,mBAAA,CAAoB,KAAK,CAAA,CAAA;AAAA,eAChB,UAAY,EAAA;AACrB,MAAA,qBAAA,CAAsB,KAAsC,CAAA,CAAA;AAAA,KAC9D;AAGA,IAAqB,oBAAA,CAAA,WAAA,KAAgB,MAAM,GAAG,CAAA,CAAA;AAC9C,IAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAAA,GACpB,CAAA;AAEA,EAAM,MAAA,eAAA,GAAkB,CAAC,KAAsC,KAAA;AAC7D,IAAA,YAAA;AAAA,MACE,gBAAiB,CAAA,OAAA,IAAW,IAAO,GAAA,KAAA,CAAA,GAAY,gBAAiB,CAAA,OAAA;AAAA,KAClE,CAAA;AACA,IAAM,MAAA,OAAA,GAAU,YAAa,QAAoC,CAAA,OAAA,CAAA;AACjE,IAAA,IAAI,OAAS,EAAA;AACX,MAAA,OAAA,CAAQ,KAAM,EAAA,CAAA;AAAA,KAChB;AAEA,IAAA,IAAI,cAAc,OAAS,EAAA;AACzB,MAAA,aAAA,CAAc,QAAQ,KAAK,CAAA,CAAA;AAAA,KAC7B;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,gBAAmB,GAAA;AAAA,IACvB,GAAG,UAAW,CAAA,UAAA;AAAA,IACd,UAAY,EAAA;AAAA,MACV,GAAI,CAAA,UAAA,CAAW,UAAc,IAAA,EAAI,EAAA,UAAA;AAAA,MACjC,IAAM,EAAA,SAAA;AAAA,MACN,sBAAwB,EAAA,sBAAA;AAAA,KAC1B;AAAA,GACF,CAAA;AAEA,EAAI,IAAA,oBAAA,IAAwB,CAAC,gBAAkB,EAAA;AAG7C,IAAA,gBAAA,CAAiB,WAAW,uBAA2B,CAAA,GAAA,oBAAA,CAAA;AAAA,GACzD;AAEA,EAAA,MAAM,iBAAoB,GAAA;AAAA,IACxB,cAAgB,EAAA,KAAA,CAAA;AAAA,IAChB,IAAM,EAAA,QAAA;AAAA,IACN,sBAAwB,EAAA,wBAAA;AAAA,IACxB,iBAAA,EAAmB,CAAC,cAAA,EAAgB,CAAG,EAAA,OAAA,CAAA,MAAA,CAAe,EACnD,MAAO,CAAA,OAAO,CACd,CAAA,IAAA,CAAK,GAAG,CAAA;AAAA,GACb,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,YAAA;AAAA,IACA,QAAU,EAAA,cAAA;AAAA,IACV,WAAa,EAAA;AAAA,MACX,KAAO,EAAA,SAAA;AAAA,MACP,OAAS,EAAA,WAAA;AAAA,KACX;AAAA,IACA,UAAY,EAAA;AAAA,MACV,GAAG,UAAA;AAAA,MACH,aAAA;AAAA,MACA,iBAAA;AAAA,MACA,EAAI,EAAA,OAAA;AAAA,MACJ,KAAO,EAAA,UAAA;AAAA,MACP,iBAAmB,EAAA,iBAAA;AAAA,MACnB,UAAY,EAAA,gBAAA;AAAA,MACZ,SAAW,EAAA,kBAAA;AAAA,KACb;AAAA,IACA,SAAW,EAAA;AAAA,MACT,GAAG,aAAA;AAAA,MACH,MAAA;AAAA,MACA,YAAA;AAAA,MACA,wBAAA;AAAA,MACA,OAAS,EAAA,eAAA;AAAA,MACT,UAAY,EAAA,UAAA,IAAc,OAAQ,CAAA,MAAA,CAAO,MAAM,CAAA;AAAA,KACjD;AAAA,GACF,CAAA;AACF;;;;"}

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

@@ -0,0 +1,277 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var collectionItemUtils = require('./utils/collection-item-utils.js');
+var filterUtils = require('./utils/filter-utils.js');
+var itemToString = require('./itemToString.js');
+var collectionProvider = require('./collectionProvider.js');
+
+const defaultCollectionOptions = {};
+const useCollectionItems = ({
+  children,
+  id: idRoot,
+  label = "",
+  options = defaultCollectionOptions,
+  source
+}) => {
+  var _a;
+  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((_a = options.filterPattern) != null ? _a : "");
+  const {
+    getFilterRegex = filterUtils.getDefaultFilterRegex,
+    noChildrenLabel,
+    itemToString: itemToString$1 = itemToString.itemToString
+  } = options;
+  const isExpanded = React.useCallback(
+    (path) => {
+      return options.defaultExpanded || false;
+    },
+    [options.defaultExpanded]
+  );
+  const addMetadataToItems = React.useCallback(
+    (items, indexer, level = 1, path = "", results = [], flattenedCollection2 = [], flattenedSource2 = []) => {
+      items.forEach((item, i, all) => {
+        var _a2, _b;
+        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 = (_a2 = item.id) != null ? _a2 : getItemId ? getItemId(i) : `${idRoot}-${childPath}`;
+        const expanded = nonCollapsible ? void 0 : (_b = item.expanded) != null ? _b : isExpanded(id);
+        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);
+    } else {
+      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] : 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 _a2;
+          return i.id === id || ((_a2 = i == null ? void 0 : i.childNodes) == null ? void 0 : _a2.length) && collectionItemUtils.isParentPath(i.id, id);
+        }
+      );
+      if ((sourceWithId == null ? void 0 : sourceWithId.id) === id) {
+        return flattenedSource == null ? void 0 : flattenedSource[sourceWithId.index];
+      } else 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) => 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;
+      } else if (Array.isArray(sel)) {
+        const result = [];
+        for (const item of sel) {
+          const collectionItem = toCollectionItem(item);
+          result.push(collectionItem);
+        }
+        return result;
+      } else 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) => React.isValidElement(i.value) ? i.label === item : i.value !== null && itemToString$1(i.value) === item
+        );
+        if (collectionItem) {
+          return collectionItem;
+        }
+      };
+      if (value === null) {
+        return null;
+      } else if (Array.isArray(value)) {
+        const result = [];
+        for (const item of value) {
+          const collectionItem = toCollectionItem2(item);
+          if (collectionItem) {
+            result.push(collectionItem);
+          }
+        }
+        return result;
+      } else 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,
+    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 { useCallback, useMemo, useRef, useState, isValidElement } from \"react\";\nimport {\n  CollectionItem,\n  CollectionIndexer,\n  CollectionHookProps,\n  CollectionHookResult,\n} from \"./collectionTypes\";\nimport {\n  isHeader,\n  isGroupNode,\n  childItems,\n  countChildItems,\n  FilterPredicate,\n  getDefaultFilter,\n  getDefaultFilterRegex,\n  isDisabled,\n  isFocusable,\n  isParentPath,\n  replaceCollectionItem,\n  sourceItems,\n} from \"./utils\";\nimport { itemToString as defaultItemToString } from \"./itemToString\";\n\nimport { SelectionStrategy, SingleSelectionStrategy } from \"./selectionTypes\";\nimport { useCollection } from \"./collectionProvider\";\n\nconst defaultCollectionOptions = {};\n\nexport const useCollectionItems = <Item>({\n  children,\n  id: idRoot,\n  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    (path: string) => {\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    },\n    [options.defaultExpanded]\n  );\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(id);\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    } else {\n      return null;\n    }\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) {\n        //TODO do we need the flattered source at all ?\n        return flattenedSource?.[sourceWithId.index!] as Item;\n      } else 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        //@ts-ignore\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      } else 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      } else 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          //@ts-ignore\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      } else 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      } else 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","_a","countChildItems","isDisabled","isFocusable","children","getDefaultFilter","isHeader","isGroupNode","sourceItems","childItems","isParentPath","isValidElement","toCollectionItem","replaceCollectionItem"],"mappings":";;;;;;;;;;AA0BA,MAAM,2BAA2B,EAAC,CAAA;AAE3B,MAAM,qBAAqB,CAAO;AAAA,EACvC,QAAA;AAAA,EACA,EAAI,EAAA,MAAA;AAAA,EACJ,KAAQ,GAAA,EAAA;AAAA,EACR,OAAU,GAAA,wBAAA;AAAA,EAEV,MAAA;AACF,CAA6D,KAAA;AAnC7D,EAAA,IAAA,EAAA,CAAA;AAoCE,EAAM,MAAA,EAAE,WAAc,GAAA,OAAA,CAAA;AAEtB,EAAA,MAAM,GAAG,WAAW,CAAA,GAAIA,eAAkB,IAAI,CAAA,CAAA;AAC9C,EAAA,MAAM,0BAA0BC,gCAAoB,EAAA,CAAA;AACpD,EAAM,MAAA,OAAA,GAAUC,YAA+B,CAAA,EAAE,CAAA,CAAA;AACjD,EAAM,MAAA,gBAAA,GAAmBA,YAA+B,CAAA,EAAE,CAAA,CAAA;AAC1D,EAAA,MAAM,mBAA2CC,aAAQ,CAAA,MAAM,EAAC,EAAG,EAAE,CAAA,CAAA;AACrE,EAAA,MAAM,aAAgB,GAAAD,YAAA,CAAA,CAAe,EAAQ,GAAA,OAAA,CAAA,aAAA,KAAR,YAAyB,EAAE,CAAA,CAAA;AAGhE,EAAM,MAAA;AAAA,IACJ,cAAiB,GAAAE,iCAAA;AAAA,IACjB,eAAA;AAAA,kBACAC,cAAe,GAAAC,yBAAA;AAAA,GACb,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,UAAa,GAAAC,iBAAA;AAAA,IACjB,CAAC,IAAiB,KAAA;AAMhB,MAAA,OAAO,QAAQ,eAAmB,IAAA,KAAA,CAAA;AAAA,KACpC;AAAA,IACA,CAAC,QAAQ,eAAe,CAAA;AAAA,GAC1B,CAAA;AAEA,EAAA,MAAM,kBAAqB,GAAAA,iBAAA;AAAA,IACzB,CACE,KAAA,EACA,OACA,EAAA,KAAA,GAAQ,GACR,IAAO,GAAA,EAAA,EACP,OAAkC,GAAA,IAClCC,oBAA8C,GAAA,EAC9CC,EAAAA,gBAAAA,GAAmC,EACmC,KAAA;AACtE,MAAA,KAAA,CAAM,OAAQ,CAAA,CAAC,IAAM,EAAA,CAAA,EAAG,GAAQ,KAAA;AA1EtC,QAAA,IAAAC,GAAA,EAAA,EAAA,CAAA;AA2EQ,QAAM,MAAA,mBAAA,GAAsB,IAAK,CAAA,MAAA,IAAU,OAAQ,CAAA,kBAAA,CAAA;AACnD,QAAA,MAAM,yBACJ,GAAA,IAAA,CAAK,UAAc,IAAA,OAAA,CAAQ,kBAAuB,KAAA,KAAA,CAAA;AACpD,QAAA,MAAM,SAAS,CAAC,IAAA,CAAK,UAAc,IAAA,IAAA,CAAK,WAAW,MAAW,KAAA,CAAA,CAAA;AAC9D,QAAM,MAAA,cAAA,GACJ,yBAA8B,IAAA,MAAA,IAAU,CAAC,mBAAA,CAAA;AAC3C,QAAA,MAAM,SAAY,GAAA,IAAA,GAAO,CAAG,EAAA,IAAA,CAAA,CAAA,EAAQ,MAAM,CAAQ,KAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAIlD,QAAM,MAAA,EAAA,GAAA,CACJA,GAAA,GAAA,IAAA,CAAK,EAAL,KAAA,IAAA,GAAAA,GAAY,GAAA,SAAA,GAAY,SAAU,CAAA,CAAC,CAAI,GAAA,CAAA,EAAG,MAAU,CAAA,CAAA,EAAA,SAAA,CAAA,CAAA,CAAA;AAEtD,QAAA,MAAM,WAAW,cACb,GAAA,KAAA,CAAA,GAAA,CACA,UAAK,QAAL,KAAA,IAAA,GAAA,EAAA,GAAiB,WAAW,EAAE,CAAA,CAAA;AAGlC,QAAA,MAAM,cAAuC,GAAA;AAAA,UAC3C,GAAG,IAAA;AAAA,UACH,UAAY,EAAA,KAAA,CAAA;AAAA,UACZ,KAAA,EACE,CAAC,yBAA6B,IAAA,QAAA,KAAa,SACvC,CACA,GAAAC,mCAAA,CAAgB,IAAM,EAAA,GAAA,EAAK,CAAC,CAAA;AAAA,UAClC,aAAa,IAAK,CAAA,WAAA;AAAA,UAClB,QAAA,EAAUC,8BAAW,CAAA,IAAA,CAAK,KAAK,CAAA;AAAA,UAC/B,SAAW,EAAAC,+BAAA,CAAY,IAAK,CAAA,KAAK,IAAI,KAAY,CAAA,GAAA,KAAA;AAAA,UACjD,EAAA;AAAA,UACA,OAAO,OAAQ,CAAA,KAAA;AAAA,UACf,QAAA;AAAA,UACA,KAAA;AAAA,SACF,CAAA;AACA,QAAA,OAAA,CAAQ,KAAK,cAAc,CAAA,CAAA;AAC3B,QAAAL,oBAAAA,CAAoB,KAAK,cAAc,CAAA,CAAA;AACvC,QAAAC,gBAAgB,CAAA,IAAA,CAAK,KAAM,CAAA,CAAA,CAAA,CAAG,KAAK,CAAA,CAAA;AAEnC,QAAA,OAAA,CAAQ,KAAS,IAAA,CAAA,CAAA;AAGjB,QAAA,IAAI,KAAK,UAAY,EAAA;AACnB,UAAM,MAAA,CAACK,SAAQ,CAAI,GAAA,kBAAA;AAAA,YACjB,IAAK,CAAA,UAAA;AAAA,YACL,OAAA;AAAA,YACA,KAAQ,GAAA,CAAA;AAAA,YACR,SAAA;AAAA,YACA,EAAC;AAAA,YACDN,oBAAAA;AAAA,YACAC,gBAAAA;AAAA,WACF,CAAA;AACA,UAAA,cAAA,CAAe,UAAaK,GAAAA,SAAAA,CAAAA;AAAA,SAC9B;AAAA,OACD,CAAA,CAAA;AACD,MAAO,OAAA,CAAC,OAASL,EAAAA,gBAAAA,EAAiBD,oBAAmB,CAAA,CAAA;AAAA,KACvD;AAAA,IACA,CAAC,OAAA,CAAQ,kBAAoB,EAAA,SAAA,EAAW,QAAQ,UAAU,CAAA;AAAA,GAC5D,CAAA;AAEA,EAAM,MAAA,SAAA,GAAYD,kBAAY,MAAM;AAClC,IAAA,IAAI,cAAc,OAAS,EAAA;AACzB,MAAO,OAAAQ,4BAAA,CAAiB,aAAc,CAAA,OAAA,EAAS,cAAc,CAAA,CAAA;AAAA,KACxD,MAAA;AACL,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF,EAAG,CAAC,cAAc,CAAC,CAAA,CAAA;AAEnB,EAAA,MAAM,mBAAsB,GAAAR,iBAAA;AAAA,IAC1B,CACE,KAAA,EACA,MAAiC,GAAA,SAAA,EACjC,EAAA,OAAA,GAAkC,EAAC,EACnC,GAAyB,GAAA,EAAE,KAAO,EAAA,CAAA,EACP,KAAA;AAC3B,MAAA,IAAI,gBAAmB,GAAA,KAAA,CAAA;AACvB,MAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,QAAA,IAAI,EAAE,gBAAA,IAAoB,CAACS,4BAAA,CAAS,IAAI,CAAI,CAAA,EAAA;AAC1C,UACE,IAAA,IAAA,CAAK,KAAU,KAAA,IAAA,KACd,MAAW,KAAA,IAAA,IAAQ,OAAOX,cAAa,CAAA,IAAA,CAAK,KAAK,CAAC,CACnD,CAAA,EAAA;AACA,YAAA,OAAA,CAAQ,IAAI,KAAS,CAAA,GAAA,IAAA,CAAA;AACrB,YAAA,GAAA,CAAI,KAAS,IAAA,CAAA,CAAA;AAAA,WACf;AACA,UAAmB,gBAAA,GAAA,KAAA,CAAA;AACnB,UAAA,IAAIW,4BAAS,CAAA,IAAI,CAAK,IAAA,IAAA,CAAK,aAAa,KAAO,EAAA;AAC7C,YAAmB,gBAAA,GAAA,IAAA,CAAA;AAAA,WACrB,MAAA,IAAWC,+BAAY,CAAA,IAAI,CAAG,EAAA;AAC5B,YAAA,IAAI,IAAK,CAAA,QAAA,KAAa,KAAS,IAAA,IAAA,CAAK,UAAY,EAAA;AAC9C,cAAA,mBAAA,CAAoB,IAAK,CAAA,UAAA,EAAY,MAAQ,EAAA,OAAA,EAAS,GAAG,CAAA,CAAA;AAAA,aAC3D;AAAA,WACF;AAAA,SACF;AAAA,OACF;AACA,MAAO,OAAA,OAAA,CAAA;AAAA,KACT;AAAA,IACA,CAAC,WAAWZ,cAAY,CAAA;AAAA,GAC1B,CAAA;AAGA,EAAM,MAAA,sBAAA,GAAyBF,cAAQ,MAAM;AAC3C,IAAA,OAAO,uBACH,GAAA,gBAAA,GACAe,+BAAkB,CAAA,MAAA,EAAQ,gBAAEb,cAAA,EAAc,eAAgB,EAAC,CACzD,IAAAc,8BAAA,CAAW,QAAQ,CAAA,IACnB,EAAC,CAAA;AAAA,GACN,EAAA;AAAA,IACD,uBAAA;AAAA,IACA,gBAAA;AAAA,IACA,MAAA;AAAA,IACAd,cAAA;AAAA,IACA,eAAA;AAAA,IACA,QAAA;AAAA,GACD,CAAA,CAAA;AAGD,EAAA,MAAM,CAAC,eAAA,EAAiB,eAAiB,EAAA,mBAAmB,CAAI,GAAAF,aAAA;AAAA,IAC9D,MACE,uBAAA,GACI,CAAC,gBAAA,EAAkB,gBAAkB,EAAA,gBAAgB,CAErD,GAAA,kBAAA,CAAyB,sBAAwB,EAAA,EAAE,KAAO,EAAA,CAAA,EAAG,CAAA;AAAA,IACnE;AAAA,MACE,gBAAA;AAAA,MACA,kBAAA;AAAA,MACA,uBAAA;AAAA,MACA,sBAAA;AAAA,KACF;AAAA,GACF,CAAA;AACA,EAAA,gBAAA,CAAiB,OAAU,GAAA,mBAAA,CAAA;AAG3B,EAAAA,aAAA;AAAA,IACE,MACE,uBACI,GAAA,gBAAA,GACC,OAAQ,CAAA,OAAA,GAAU,oBAAoB,eAAe,CAAA;AAAA,IAC5D;AAAA,MACE,gBAAA;AAAA,MACA,mBAAA;AAAA,MACA,eAAA;AAAA,MACA,uBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,kBAAA,GAAqBD,aAAO,eAAe,CAAA,CAAA;AAEjD,EAAA,MAAM,gBAAmB,GAAAK,iBAAA;AAAA,IACvB,CAAC,UAAU,EAAO,KAAA;AAChB,MAAI,IAAA,OAAO,YAAY,QAAU,EAAA;AAC/B,QAAA,aAAA,CAAc,OAAU,GAAA,OAAA,CAAA;AACxB,QAAQ,OAAA,CAAA,OAAA,GAAU,oBAAoB,eAAe,CAAA,CAAA;AACrD,QAAA,WAAA,CAAY,EAAE,CAAA,CAAA;AAAA,OAChB;AAAA,KACF;AAAA,IACA,CAAC,iBAAiB,mBAAmB,CAAA;AAAA,GACvC,CAAA;AAEA,EAAA,MAAM,QAAW,GAAAA,iBAAA;AAAA,IACf,CACE,EACA,EAAA,MAAA,GAAiC,eAChB,KAAA;AACjB,MAAA,MAAM,eAAe,MAAO,CAAA,IAAA;AAAA,QAC1B,CAAC,CAAG,KAAA;AA9OZ,UAAAG,IAAAA,GAAAA,CAAAA;AA8Oe,UAAE,OAAA,CAAA,CAAA,EAAA,KAAO,EAAOA,IAAAA,CAAAA,CAAAA,GAAAA,GAAA,CAAG,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,CAAA,CAAA,UAAA,KAAH,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,GAAAA,CAAe,MAAU,KAAAU,gCAAA,CAAa,CAAE,CAAA,EAAA,EAAI,EAAE,CAAA,CAAA;AAAA,SAAA;AAAA,OACvE,CAAA;AACA,MAAI,IAAA,CAAA,YAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,YAAA,CAAc,QAAO,EAAI,EAAA;AAE3B,QAAA,OAAO,mDAAkB,YAAa,CAAA,KAAA,CAAA,CAAA;AAAA,iBAC7B,YAAc,EAAA;AACvB,QAAO,OAAA,QAAA,CAAS,EAAI,EAAA,YAAA,CAAa,UAAU,CAAA,CAAA;AAAA,OAC7C;AACA,MAAM,MAAA,KAAA,CAAM,kCAAkC,EAAe,CAAA,WAAA,CAAA,CAAA,CAAA;AAAA,KAC/D;AAAA,IACA,CAAC,iBAAiB,eAAe,CAAA;AAAA,GACnC,CAAA;AAEA,EAAA,MAAM,gBAAmB,GAAAb,iBAAA;AAAA,IACvB,CAAC,IAA6C,KAAA;AAE5C,MAAM,MAAA,cAAA,GAAiB,iBAAiB,OAAQ,CAAA,IAAA;AAAA,QAAK,CAAC,CAGpD,KAAAc,oBAAA,CAAe,CAAE,CAAA,KAAK,IAAI,CAAE,CAAA,KAAA,KAAU,IAAO,GAAA,CAAA,CAAE,KAAU,KAAA,IAAA;AAAA,OAC3D,CAAA;AACA,MAAA,IAAI,cAAgB,EAAA;AAClB,QAAO,OAAA,cAAA,CAAA;AAAA,OACT;AACA,MAAA,MAAM,MAAM,CAAqD,mDAAA,CAAA,CAAA,CAAA;AAAA,KACnE;AAAA,IACA,EAAC;AAAA,GACH,CAAA;AAIA,EAAA,MAAM,oBAAuB,GAAAd,iBAAA;AAAA,IAC3B,CAIE,GAG4B,KAAA;AAK5B,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAO,OAAA,IAAA,CAAA;AAAA,OACE,MAAA,IAAA,KAAA,CAAM,OAAQ,CAAA,GAAG,CAAG,EAAA;AAC7B,QAAA,MAAM,SAAiC,EAAC,CAAA;AACxC,QAAA,KAAA,MAAW,QAAQ,GAAK,EAAA;AACtB,UAAM,MAAA,cAAA,GAAiB,iBAAiB,IAAI,CAAA,CAAA;AAC5C,UAAA,MAAA,CAAO,KAAK,cAAc,CAAA,CAAA;AAAA,SAC5B;AACA,QAAO,OAAA,MAAA,CAAA;AAAA,OACT,MAAA,IAAW,QAAQ,KAAW,CAAA,EAAA;AAC5B,QAAA,OAAO,iBAAiB,GAAW,CAAA,CAAA;AAAA,OACrC;AAEA,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAAA,IACA,CAAC,gBAAgB,CAAA;AAAA,GACnB,CAAA;AAEA,EAAA,MAAM,sBAAyB,GAAAA,iBAAA;AAAA,IAC7B,CACE,KAG4B,KAAA;AAK5B,MAAMe,MAAAA,iBAAAA,GAAmB,CACvB,IAC6C,KAAA;AAE7C,QAAM,MAAA,cAAA,GAAiB,iBAAiB,OAAQ,CAAA,IAAA;AAAA,UAAK,CAAC,CAAA,KAGpDD,oBAAe,CAAA,CAAA,CAAE,KAAK,CAClB,GAAA,CAAA,CAAE,KAAU,KAAA,IAAA,GACZ,EAAE,KAAU,KAAA,IAAA,IAAQhB,cAAa,CAAA,CAAA,CAAE,KAAK,CAAM,KAAA,IAAA;AAAA,SACpD,CAAA;AACA,QAAA,IAAI,cAAgB,EAAA;AAClB,UAAO,OAAA,cAAA,CAAA;AAAA,SACT;AAAA,OACF,CAAA;AAEA,MAAA,IAAI,UAAU,IAAM,EAAA;AAClB,QAAO,OAAA,IAAA,CAAA;AAAA,OACE,MAAA,IAAA,KAAA,CAAM,OAAQ,CAAA,KAAK,CAAG,EAAA;AAC/B,QAAA,MAAM,SAAiC,EAAC,CAAA;AACxC,QAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,UAAM,MAAA,cAAA,GAAiBiB,kBAAiB,IAAI,CAAA,CAAA;AAC5C,UAAA,IAAI,cAAgB,EAAA;AAClB,YAAA,MAAA,CAAO,KAAK,cAAc,CAAA,CAAA;AAAA,WAC5B;AAAA,SACF;AACA,QAAO,OAAA,MAAA,CAAA;AAAA,OACT,MAAA,IAAW,UAAU,KAAW,CAAA,EAAA;AAC9B,QAAA,OAAOA,kBAAiB,KAAK,CAAA,CAAA;AAAA,OAC/B;AAEA,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAAA,IACA,CAACjB,cAAY,CAAA;AAAA,GACf,CAAA;AAEA,EAAM,MAAA,QAAA,GAAWE,iBAAY,CAAA,CAAC,IAAuB,KAAA;AACnD,IAAW,KAAA,MAAA,cAAA,IAAkB,mBAAmB,OAAS,EAAA;AACvD,MAAI,IAAA,IAAA,KAAS,eAAe,KAAO,EAAA;AACjC,QAAA,OAAO,cAAe,CAAA,EAAA,CAAA;AAAA,OACxB;AAAA,KACF;AACA,IAAA,MAAM,MAAM,4CAA4C,CAAA,CAAA;AAAA,GAC1D,EAAG,EAAE,CAAA,CAAA;AAEL,EAAA,MAAM,iBAAoB,GAAAA,iBAAA;AAAA,IACxB,CAAC,IAA+B,KAAA;AAC9B,MAAA,kBAAA,CAAmB,OAAU,GAAAgB,yCAAA;AAAA,QAC3B,kBAAmB,CAAA,OAAA;AAAA,QACnB,IAAK,CAAA,EAAA;AAAA,QACL;AAAA,UACE,QAAU,EAAA,KAAA;AAAA,SACZ;AAAA,OACF,CAAA;AACA,MAAQ,OAAA,CAAA,OAAA,GAAU,mBAAoB,CAAA,kBAAA,CAAmB,OAAO,CAAA,CAAA;AAChE,MAAA,WAAA,CAAY,EAAE,CAAA,CAAA;AAAA,KAChB;AAAA,IACA,CAAC,mBAAmB,CAAA;AAAA,GACtB,CAAA;AAEA,EAAA,MAAM,eAAkB,GAAAhB,iBAAA;AAAA,IACtB,CAAC,IAA+B,KAAA;AAC9B,MAAA,kBAAA,CAAmB,OAAU,GAAAgB,yCAAA;AAAA,QAC3B,kBAAmB,CAAA,OAAA;AAAA,QACnB,IAAK,CAAA,EAAA;AAAA,QACL;AAAA,UACE,QAAU,EAAA,IAAA;AAAA,SACZ;AAAA,OACF,CAAA;AACA,MAAQ,OAAA,CAAA,OAAA,GAAU,mBAAoB,CAAA,kBAAA,CAAmB,OAAO,CAAA,CAAA;AAChE,MAAA,WAAA,CAAY,EAAE,CAAA,CAAA;AAAA,KAChB;AAAA,IACA,CAAC,mBAAmB,CAAA;AAAA,GACtB,CAAA;AAEA,EAAA,OACE,uBAA2B,IAAA;AAAA,IACzB,iBAAA;AAAA,IACA,MAAM,OAAQ,CAAA,OAAA;AAAA,IACd,eAAA;AAAA,IACA,gBAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA,gBAAA;AAAA,IACA,oBAAA;AAAA,IACA,sBAAA;AAAA,GACF,CAAA;AAEJ;;;;"}

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

@@ -0,0 +1,294 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+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;
+    } else {
+      return idx;
+    }
+  } else {
+    if (idx === null) {
+      return 0;
+    } else if (idx === count - 1) {
+      return idx;
+    } else {
+      return idx + 1;
+    }
+  }
+}
+const getIndexOfSelectedItem = (items, selected) => {
+  const selectedItem = selectionTypes.getFirstSelectedItem(selected);
+  if (selectedItem) {
+    return items.indexOf(selectedItem);
+  } else {
+    return -1;
+  }
+};
+const getStartIdx = (key, idx, selectedIdx, length) => {
+  if (key === keyUtils.End) {
+    return length;
+  } else if (key === keyUtils.Home) {
+    return -1;
+  } else if (idx !== -1) {
+    return idx;
+  } else {
+    return selectedIdx;
+  }
+};
+const getItemRect = (item) => {
+  const el = document.getElementById(item.id);
+  if (el) {
+    return el.getBoundingClientRect();
+  } else {
+    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, setHighlightedIdx]
+  );
+  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 != null ? result : index;
+    },
+    [containerRef, indexPositions]
+  );
+  const nextFocusableItemIdx = React.useCallback(
+    (key = keyUtils.ArrowDown, idx = key === keyUtils.ArrowDown ? -1 : indexPositions.length) => {
+      if (indexPositions.length === 0) {
+        return -1;
+      } else {
+        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 = (value) => ignoreFocus.current = value;
+  const handleFocus = React.useCallback(
+    (e) => {
+      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);
+      },
+      onMouseMove: () => {
+        if (keyboardNavigation.current) {
+          keyboardNavigation.current = false;
+        }
+      },
+      onMouseLeave: () => {
+        keyboardNavigation.current = false;
+        setIgnoreFocus(false);
+        setHighlightedIndex(-1);
+      }
+    };
+  }, [
+    handleFocus,
+    handleKeyDown,
+    restoreLastFocus,
+    setHighlightedIdx,
+    setHighlightedIndex
+  ]);
+  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