@primer/components 30.3.0-rc.2010c7d4 → 30.3.0-rc.9dbc85a9

package/lib-esm/Autocomplete/AutocompleteMenu.js

@@ -0,0 +1,205 @@
+import React, { useContext, useEffect, useMemo, useRef, useState } from 'react';
+import { ActionList } from '../ActionList';
+import { useFocusZone } from '../hooks/useFocusZone';
+import { Box, Spinner } from '../';
+import { AutocompleteContext } from './AutocompleteContext';
+import { PlusIcon } from '@primer/octicons-react';
+import { uniqueId } from '../utils/uniqueId';
+import { scrollIntoViewingArea } from '../behaviors/scrollIntoViewingArea';
+
+const getDefaultSortFn = isItemSelectedFn => (itemIdA, itemIdB) => isItemSelectedFn(itemIdA) === isItemSelectedFn(itemIdB) ? 0 : isItemSelectedFn(itemIdA) ? -1 : 1;
+
+function getDefaultItemFilter(filterValue) {
+  return function (item, _i) {
+    var _item$text;
+
+    return Boolean((_item$text = item.text) === null || _item$text === void 0 ? void 0 : _item$text.toLowerCase().startsWith(filterValue.toLowerCase()));
+  };
+}
+
+function getDefaultOnSelectionChange(setInputValueFn) {
+  return function (itemOrItems) {
+    const {
+      text = ''
+    } = Array.isArray(itemOrItems) ? itemOrItems.slice(-1)[0] : itemOrItems;
+    setInputValueFn(text);
+  };
+}
+
+const isItemSelected = (itemId, selectedItemIds) => selectedItemIds.includes(itemId);
+
+function getItemById(itemId, items) {
+  return items.find(item => item.id === itemId);
+} // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+
+function AutocompleteMenu(props) {
+  const autocompleteContext = useContext(AutocompleteContext);
+
+  if (autocompleteContext === null) {
+    throw new Error('AutocompleteContext returned null values');
+  }
+
+  const {
+    activeDescendantRef,
+    id,
+    inputRef,
+    inputValue = '',
+    scrollContainerRef,
+    setAutocompleteSuggestion,
+    setShowMenu,
+    setInputValue,
+    setIsMenuDirectlyActivated,
+    setSelectedItemLength,
+    showMenu
+  } = autocompleteContext;
+  const {
+    items,
+    selectedItemIds,
+    sortOnCloseFn,
+    emptyStateText,
+    addNewItem,
+    loading,
+    selectionVariant,
+    filterFn,
+    'aria-labelledby': ariaLabelledBy,
+    onOpenChange,
+    onSelectedChange,
+    customScrollContainerRef
+  } = props;
+  const listContainerRef = useRef(null);
+  const [highlightedItem, setHighlightedItem] = useState();
+  const [sortedItemIds, setSortedItemIds] = useState(items.map(({
+    id: itemId
+  }) => itemId));
+  const selectableItems = useMemo(() => items.map(selectableItem => {
+    return { ...selectableItem,
+      role: 'option',
+      id: selectableItem.id,
+      selected: selectionVariant === 'multiple' ? selectedItemIds.includes(selectableItem.id) : undefined,
+      onAction: item => {
+        const otherSelectedItemIds = selectedItemIds.filter(selectedItemId => selectedItemId !== item.id);
+        const newSelectedItemIds = selectedItemIds.includes(item.id) ? otherSelectedItemIds : [...otherSelectedItemIds, item.id];
+        const onSelectedChangeFn = onSelectedChange ? onSelectedChange : getDefaultOnSelectionChange(setInputValue);
+        onSelectedChangeFn(newSelectedItemIds.map(newSelectedItemId => getItemById(newSelectedItemId, items)));
+
+        if (selectionVariant === 'multiple') {
+          setInputValue('');
+          setAutocompleteSuggestion('');
+        } else {
+          var _inputRef$current;
+
+          setShowMenu(false);
+          (_inputRef$current = inputRef.current) === null || _inputRef$current === void 0 ? void 0 : _inputRef$current.setSelectionRange(inputRef.current.value.length, inputRef.current.value.length);
+        }
+      }
+    };
+  }), [items, selectedItemIds, inputRef, onSelectedChange, selectionVariant, setAutocompleteSuggestion, setInputValue, setShowMenu]);
+  const itemSortOrderData = useMemo(() => sortedItemIds.reduce((acc, curr, i) => {
+    acc[curr] = i;
+    return acc;
+  }, {}), [sortedItemIds]);
+  const sortedAndFilteredItemsToRender = useMemo(() => selectableItems.filter(filterFn ? filterFn : getDefaultItemFilter(inputValue)).sort((a, b) => itemSortOrderData[a.id] - itemSortOrderData[b.id]), [selectableItems, itemSortOrderData, filterFn, inputValue]);
+  const allItemsToRender = useMemo(() => [// sorted and filtered selectable items
+  ...sortedAndFilteredItemsToRender, // menu item used for creating a token from whatever is in the text input
+  ...(addNewItem ? [{ ...addNewItem,
+    leadingVisual: () => /*#__PURE__*/React.createElement(PlusIcon, null),
+    onAction: item => {
+      // TODO: make it possible to pass a leadingVisual when using `addNewItem`
+      addNewItem.handleAddItem({ ...item,
+        id: item.id || uniqueId(),
+        leadingVisual: undefined
+      });
+
+      if (selectionVariant === 'multiple') {
+        setInputValue('');
+        setAutocompleteSuggestion('');
+      }
+    }
+  }] : [])], [sortedAndFilteredItemsToRender, addNewItem, setAutocompleteSuggestion, selectionVariant, setInputValue]);
+  useFocusZone({
+    containerRef: listContainerRef,
+    focusOutBehavior: 'wrap',
+    focusableElementFilter: element => {
+      return !(element instanceof HTMLInputElement);
+    },
+    activeDescendantFocus: inputRef,
+    onActiveDescendantChanged: (current, _previous, directlyActivated) => {
+      activeDescendantRef.current = current || null;
+
+      if (current) {
+        const selectedItem = selectableItems.find(item => item.id.toString() === current.getAttribute('data-id'));
+        setHighlightedItem(selectedItem);
+        setIsMenuDirectlyActivated(directlyActivated);
+      }
+
+      if (current && customScrollContainerRef && customScrollContainerRef.current && directlyActivated) {
+        scrollIntoViewingArea(current, customScrollContainerRef.current);
+      } else if (current && scrollContainerRef.current && directlyActivated) {
+        scrollIntoViewingArea(current, scrollContainerRef.current);
+      }
+    }
+  }, [loading]);
+  useEffect(() => {
+    var _highlightedItem$text;
+
+    if (highlightedItem !== null && highlightedItem !== void 0 && (_highlightedItem$text = highlightedItem.text) !== null && _highlightedItem$text !== void 0 && _highlightedItem$text.startsWith(inputValue) && !selectedItemIds.includes(highlightedItem.id)) {
+      setAutocompleteSuggestion(highlightedItem.text);
+    } else {
+      setAutocompleteSuggestion('');
+    }
+  }, [highlightedItem, inputValue, selectedItemIds, setAutocompleteSuggestion]);
+  useEffect(() => {
+    const itemIdSortResult = [...sortedItemIds].sort(sortOnCloseFn ? sortOnCloseFn : getDefaultSortFn(itemId => isItemSelected(itemId, selectedItemIds)));
+    const sortResultMatchesState = itemIdSortResult.length === sortedItemIds.length && itemIdSortResult.every((element, index) => element === sortedItemIds[index]);
+
+    if (showMenu === false && !sortResultMatchesState) {
+      setSortedItemIds(itemIdSortResult);
+    }
+
+    onOpenChange && onOpenChange(Boolean(showMenu));
+  }, [showMenu, onOpenChange, selectedItemIds, sortOnCloseFn, sortedItemIds]);
+  useEffect(() => {
+    if (selectedItemIds.length) {
+      setSelectedItemLength(selectedItemIds.length);
+    }
+  }, [selectedItemIds, setSelectedItemLength]);
+  return /*#__PURE__*/React.createElement(Box, {
+    sx: !showMenu ? {
+      // visually hides this label for sighted users
+      position: 'absolute',
+      width: '1px',
+      height: '1px',
+      padding: '0',
+      margin: '-1px',
+      overflow: 'hidden',
+      clip: 'rect(0, 0, 0, 0)',
+      whiteSpace: 'nowrap',
+      borderWidth: '0'
+    } : {}
+  }, loading ? /*#__PURE__*/React.createElement(Box, {
+    p: 3,
+    display: "flex",
+    justifyContent: "center"
+  }, /*#__PURE__*/React.createElement(Spinner, null)) : /*#__PURE__*/React.createElement("div", {
+    ref: listContainerRef
+  }, allItemsToRender.length ? /*#__PURE__*/React.createElement(ActionList, {
+    selectionVariant: "multiple" // have to typecast to `ItemProps` because we have an extra property
+    // on `items` for Autocomplete: `metadata`
+    ,
+    items: allItemsToRender,
+    role: "listbox",
+    id: `${id}-listbox`,
+    "aria-labelledby": ariaLabelledBy
+  }) : /*#__PURE__*/React.createElement(Box, {
+    p: 3
+  }, emptyStateText)));
+}
+
+AutocompleteMenu.displayName = "AutocompleteMenu";
+AutocompleteMenu.defaultProps = {
+  emptyStateText: 'No selectable options',
+  selectionVariant: 'single'
+};
+AutocompleteMenu.displayName = 'AutocompleteMenu';
+export default AutocompleteMenu;

package/lib-esm/Autocomplete/AutocompleteOverlay.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import { OverlayProps } from '../Overlay';
+import { ComponentProps } from '../utils/types';
+declare type AutocompleteOverlayInternalProps = {
+    /**
+     * The ref of the element that the position of the menu is based on. By default, the menu is positioned based on the text input
+     */
+    menuAnchorRef?: React.RefObject<HTMLElement>;
+    /**
+     * Props to be spread on the internal `Overlay` component.
+     */
+    overlayProps?: Partial<OverlayProps>;
+    children?: React.ReactNode;
+} & Pick<React.AriaAttributes, 'aria-labelledby'>;
+declare function AutocompleteOverlay({ menuAnchorRef, overlayProps, children }: AutocompleteOverlayInternalProps): JSX.Element | null;
+declare namespace AutocompleteOverlay {
+    var displayName: string;
+}
+export declare type AutocompleteOverlayProps = ComponentProps<typeof AutocompleteOverlay>;
+export default AutocompleteOverlay;

package/lib-esm/Autocomplete/AutocompleteOverlay.js

@@ -0,0 +1,62 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+import React, { useCallback, useContext } from 'react';
+import { useAnchoredPosition } from '../hooks';
+import Overlay from '../Overlay';
+import { AutocompleteContext } from './AutocompleteContext';
+import { useCombinedRefs } from '../hooks/useCombinedRefs';
+
+// TODO: consider making 'aria-labelledby' required
+function AutocompleteOverlay({
+  menuAnchorRef,
+  overlayProps,
+  children
+}) {
+  const autocompleteContext = useContext(AutocompleteContext);
+
+  if (autocompleteContext === null) {
+    throw new Error('AutocompleteContext returned null values');
+  }
+
+  const {
+    inputRef,
+    scrollContainerRef,
+    selectedItemLength,
+    setShowMenu,
+    showMenu = false
+  } = autocompleteContext;
+  const {
+    floatingElementRef,
+    position
+  } = useAnchoredPosition({
+    side: 'outside-bottom',
+    align: 'start',
+    anchorElementRef: menuAnchorRef ? menuAnchorRef : inputRef
+  }, [showMenu, selectedItemLength]);
+  const combinedOverlayRef = useCombinedRefs(scrollContainerRef, floatingElementRef);
+  const closeOptionList = useCallback(() => {
+    setShowMenu(false);
+  }, [setShowMenu]);
+
+  if (typeof window === 'undefined') {
+    return null;
+  }
+
+  return /*#__PURE__*/React.createElement(Overlay, _extends({
+    returnFocusRef: inputRef,
+    preventFocusOnOpen: true,
+    onClickOutside: closeOptionList,
+    onEscape: closeOptionList,
+    ref: combinedOverlayRef,
+    top: position === null || position === void 0 ? void 0 : position.top,
+    left: position === null || position === void 0 ? void 0 : position.left,
+    visibility: showMenu ? 'visible' : 'hidden',
+    sx: {
+      overflow: 'auto'
+    }
+  }, overlayProps), children);
+}
+
+AutocompleteOverlay.displayName = "AutocompleteOverlay";
+AutocompleteOverlay.displayName = 'AutocompleteOverlay';
+export default AutocompleteOverlay;

package/lib-esm/Autocomplete/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './Autocomplete';
+export type { AutocompleteMenuProps, AutocompleteInputProps, AutocompleteOverlayProps } from './Autocomplete';

package/lib-esm/Autocomplete/index.js

@@ -0,0 +1 @@
+export { default } from './Autocomplete';

package/lib-esm/FilteredActionList/FilteredActionList.js

@@ -1,6 +1,7 @@
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
 import React, { useCallback, useEffect, useRef } from 'react';
+import { useSSRSafeId } from '@react-aria/ssr';
 import TextInput from '../TextInput';
 import Box from '../Box';
 import { ActionList } from '../ActionList';
@@ -11,36 +12,7 @@ import styled from 'styled-components';
 import { get } from '../constants';
 import { useProvidedRefOrCreate } from '../hooks/useProvidedRefOrCreate';
 import useScrollFlash from '../hooks/useScrollFlash';
-import { useSSRSafeId } from '@react-aria/ssr';
-
-function scrollIntoViewingArea(child, container, margin = 8, behavior = 'smooth') {
-  const {
-    top: childTop,
-    bottom: childBottom
-  } = child.getBoundingClientRect();
-  const {
-    top: containerTop,
-    bottom: containerBottom
-  } = container.getBoundingClientRect();
-  const isChildTopAboveViewingArea = childTop < containerTop + margin;
-  const isChildBottomBelowViewingArea = childBottom > containerBottom - margin;
-
-  if (isChildTopAboveViewingArea) {
-    const scrollHeightToChildTop = childTop - containerTop + container.scrollTop;
-    container.scrollTo({
-      behavior,
-      top: scrollHeightToChildTop - margin
-    });
-  } else if (isChildBottomBelowViewingArea) {
-    const scrollHeightToChildBottom = childBottom - containerBottom + container.scrollTop;
-    container.scrollTo({
-      behavior,
-      top: scrollHeightToChildBottom + margin
-    });
-  } // either completely in view or outside viewing area on both ends, don't scroll
-
-}
-
+import { scrollIntoViewingArea } from '../behaviors/scrollIntoViewingArea';
 const StyledHeader = styled.div.withConfig({
   displayName: "FilteredActionList__StyledHeader",
   componentId: "yg3jkv-0"
@@ -95,7 +67,7 @@ export function FilteredActionList({
   useEffect(() => {
     // if items changed, we want to instantly move active descendant into view
     if (activeDescendantRef.current && scrollContainerRef.current) {
-      scrollIntoViewingArea(activeDescendantRef.current, scrollContainerRef.current, undefined, 'auto');
+      scrollIntoViewingArea(activeDescendantRef.current, scrollContainerRef.current, 'vertical', undefined, undefined, 'auto');
     }
   }, [items]);
   useScrollFlash(scrollContainerRef);

package/lib-esm/Overlay.d.ts

@@ -40,6 +40,7 @@ export declare type OverlayProps = {
     top: number;
     left: number;
     portalContainerName?: string;
+    preventFocusOnOpen?: boolean;
 } & Omit<ComponentProps<typeof StyledOverlay>, 'visibility' | keyof SystemPositionProps>;
 /**
  * An `Overlay` is a flexible floating surface, used to display transient content such as menus,

package/lib-esm/Overlay.js

@@ -92,6 +92,7 @@ const Overlay = /*#__PURE__*/React.forwardRef(({
   left,
   anchorSide,
   portalContainerName,
+  preventFocusOnOpen,
   ...rest
 }, forwardedRef) => {
   const overlayRef = useRef(null);
@@ -107,7 +108,8 @@ const Overlay = /*#__PURE__*/React.forwardRef(({
     onEscape,
     ignoreClickRefs,
     onClickOutside,
-    initialFocusRef
+    initialFocusRef,
+    preventFocusOnOpen
   });
   useEffect(() => {
     var _combinedRef$current;

package/lib-esm/__tests__/Autocomplete.test.d.ts

@@ -0,0 +1 @@
+import 'babel-polyfill';