@primer/components 0.0.0-202194183411 → 0.0.0-202194215436

package/lib-esm/Autocomplete/AutocompleteInput.js

@@ -1,127 +0,0 @@
-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, useEffect, useState } from 'react';
-import { AutocompleteContext } from './AutocompleteContext';
-import TextInput from '../TextInput';
-import { useCombinedRefs } from '../hooks/useCombinedRefs';
-const AutocompleteInput = /*#__PURE__*/React.forwardRef(({
-  as: Component = TextInput,
-  onFocus,
-  onBlur,
-  onChange,
-  onKeyDown,
-  onKeyPress,
-  value,
-  ...props
-}, forwardedRef) => {
-  const {
-    activeDescendantRef,
-    autocompleteSuggestion = '',
-    id,
-    inputRef,
-    inputValue = '',
-    isMenuDirectlyActivated,
-    setInputValue,
-    setShowMenu,
-    showMenu
-  } = useContext(AutocompleteContext);
-  const combinedInputRef = useCombinedRefs(inputRef, forwardedRef);
-  const [highlightRemainingText, setHighlightRemainingText] = useState(true);
-
-  const handleInputFocus = e => {
-    onFocus && onFocus(e);
-    setShowMenu && setShowMenu(true);
-  };
-
-  const handleInputBlur = e => {
-    onBlur && onBlur(e); // HACK: wait a tick and check the focused element before hiding the autocomplete menu
-    // this prevents the menu from hiding when the user is clicking an option in the Autoselect.Menu,
-    // but still hides the menu when the user blurs the input by tabbing out or clicking somewhere else on the page
-
-    setTimeout(() => {
-      if (document.activeElement !== combinedInputRef.current) {
-        setShowMenu && setShowMenu(false);
-      }
-    }, 0);
-  };
-
-  const handleInputChange = e => {
-    onChange && onChange(e);
-    setInputValue && setInputValue(e.currentTarget.value);
-
-    if (!showMenu) {
-      setShowMenu && setShowMenu(true);
-    }
-  };
-
-  const handleInputKeyDown = e => {
-    var _inputRef$current;
-
-    if (e.key === 'Backspace') {
-      setHighlightRemainingText(false);
-    }
-
-    if (e.key === 'Escape' && inputRef !== null && inputRef !== void 0 && (_inputRef$current = inputRef.current) !== null && _inputRef$current !== void 0 && _inputRef$current.value) {
-      setInputValue && setInputValue('');
-      inputRef.current.value = '';
-    }
-  };
-
-  const handleInputKeyUp = e => {
-    if (e.key === 'Backspace') {
-      setHighlightRemainingText(true);
-    }
-  };
-
-  const onInputKeyPress = useCallback(event => {
-    if (activeDescendantRef && event.key === 'Enter' && activeDescendantRef.current) {
-      event.preventDefault();
-      event.nativeEvent.stopImmediatePropagation(); // Forward Enter key press to active descendant so that item gets activated
-
-      const activeDescendantEvent = new KeyboardEvent(event.type, event.nativeEvent);
-      activeDescendantRef.current.dispatchEvent(activeDescendantEvent);
-    }
-  }, [activeDescendantRef]);
-  useEffect(() => {
-    if (!(inputRef !== null && inputRef !== void 0 && inputRef.current)) {
-      return;
-    } // resets input value to being empty after a selection has been made
-
-
-    if (!autocompleteSuggestion) {
-      inputRef.current.value = inputValue;
-    } // TODO: fix bug where this function prevents `onChange` from being triggered if the highlighted item text
-    //       is the same as what I'm typing
-    //       e.g.: typing 'tw' highights 'two', but when I 'two', the text input change does not get triggered
-
-
-    if (highlightRemainingText && autocompleteSuggestion && (inputValue || isMenuDirectlyActivated)) {
-      inputRef.current.value = autocompleteSuggestion;
-
-      if (autocompleteSuggestion.toLowerCase().indexOf(inputValue.toLowerCase()) === 0) {
-        inputRef.current.setSelectionRange(inputValue.length, autocompleteSuggestion.length);
-      }
-    }
-  }, [autocompleteSuggestion, inputValue]);
-  useEffect(() => {
-    if (value) {
-      setInputValue && setInputValue(value.toString());
-    }
-  }, [value]);
-  return /*#__PURE__*/React.createElement(Component, _extends({
-    onFocus: handleInputFocus,
-    onBlur: handleInputBlur,
-    onChange: handleInputChange,
-    onKeyDown: handleInputKeyDown,
-    onKeyPress: onInputKeyPress,
-    onKeyUp: handleInputKeyUp,
-    ref: combinedInputRef,
-    "aria-controls": `${id}-listbox`,
-    "aria-autocomplete": "both",
-    role: "combobox",
-    "aria-expanded": showMenu,
-    "aria-haspopup": "listbox",
-    "aria-owns": `${id}-listbox`
-  }, props));
-});
-export default AutocompleteInput;

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

@@ -1,71 +0,0 @@
-import React from 'react';
-import { ItemProps } from '../ActionList';
-import { ComponentProps, MandateProps } from '../utils/types';
-declare type OnSelectedChange<T> = (item: T | T[]) => void;
-declare type AutocompleteItemProps<T = Record<string, any>> = MandateProps<ItemProps, 'id'> & {
-    metadata?: T;
-};
-declare type AutocompleteMenuInternalProps<T extends AutocompleteItemProps> = {
-    /**
-     * A menu item that is used to allow users make a selection that is not available in the array passed to the `items` prop.
-     * This menu item gets appended to the end of the list of options.
-     */
-    addNewItem?: Omit<T, 'onAction' | 'leadingVisual' | 'id'> & {
-        handleAddItem: (item: Omit<T, 'onAction' | 'leadingVisual'>) => void;
-    };
-    /**
-     * The text that appears in the menu when there are no options in the array passed to the `items` prop.
-     */
-    emptyStateText?: React.ReactNode | false;
-    /**
-     * A custom function used to filter the options in the array passed to the `items` prop.
-     * By default, we filter out items that don't match the value of the autocomplete text input. The default filter is not case-sensitive.
-     */
-    filterFn?: (item: T, i: number) => boolean;
-    /**
-     * The options for field values that are displayed in the dropdown menu.
-     * One or more may be selected depending on the value of the `selectionVariant` prop.
-     */
-    items: T[];
-    /**
-     * Whether the data is loaded for the menu items
-     */
-    loading?: boolean;
-    /**
-     * The IDs of the selected items
-     */
-    selectedItemIds: Array<string | number>;
-    /**
-     * The sort function that is applied to the options in the array passed to the `items` prop after the user closes the menu.
-     * By default, selected items are sorted to the top after the user closes the menu.
-     */
-    sortOnCloseFn?: (itemIdA: string | number, itemIdB: string | number) => number;
-    /**
-     * Whether there can be one item selected from the menu or multiple items selected from the menu
-     */
-    selectionVariant?: 'single' | 'multiple';
-    /**
-     * Function that gets called when the menu is opened or closed
-     */
-    onOpenChange?: (open: boolean) => void;
-    /**
-     * The function that is called when an item in the list is selected or deselected
-     */
-    onSelectedChange?: OnSelectedChange<T>;
-    /**
-     * If the menu is rendered in a scrolling element other than the `Autocomplete.Overlay` component,
-     * pass the ref of that element to `customScrollContainerRef` to ensure the container automatically
-     * scrolls when the user highlights an item in the menu that is outside the scroll container
-     */
-    customScrollContainerRef?: React.MutableRefObject<HTMLElement | null>;
-} & Pick<React.AriaAttributes, 'aria-labelledby'>;
-declare function AutocompleteMenu<T extends AutocompleteItemProps>(props: AutocompleteMenuInternalProps<T>): JSX.Element;
-declare namespace AutocompleteMenu {
-    var defaultProps: {
-        emptyStateText: string;
-        selectionVariant: string;
-    };
-    var displayName: string;
-}
-export declare type AutocompleteMenuProps = ComponentProps<typeof AutocompleteMenu>;
-export default AutocompleteMenu;

package/lib-esm/Autocomplete/AutocompleteMenu.js

@@ -1,202 +0,0 @@
-import React, { useContext, useEffect, useRef, useState } from 'react';
-import { ActionList } from '../ActionList';
-import { useFocusZone } from '../hooks/useFocusZone';
-import { Box, Spinner } from '../';
-import { registerPortalRoot } from '../Portal';
-import { AutocompleteContext } from './AutocompleteContext';
-import { PlusIcon } from '@primer/octicons-react';
-import { uniqueId } from '../utils/uniqueId';
-import { scrollIntoViewingArea } from '../utils/scrollIntoViewingArea';
-const DROPDOWN_PORTAL_CONTAINER_NAME = '__listcontainerportal__';
-
-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()));
-  };
-}
-
-const getDefaultOnSelectionChange = setInputValueFn => {
-  return function (itemOrItems) {
-    const {
-      text = ''
-    } = Array.isArray(itemOrItems) ? itemOrItems.slice(-1)[0] : itemOrItems;
-    setInputValueFn && setInputValueFn(text);
-  };
-};
-
-// TODO: consider making 'aria-labelledby' required
-function AutocompleteMenu(props) {
-  const {
-    activeDescendantRef,
-    id,
-    inputRef,
-    inputValue = '',
-    scrollContainerRef,
-    setAutocompleteSuggestion,
-    setShowMenu,
-    setInputValue,
-    setIsMenuDirectlyActivated,
-    setSelectedItemLength,
-    showMenu
-  } = useContext(AutocompleteContext);
-  const {
-    items,
-    selectedItemIds,
-    sortOnCloseFn,
-    emptyStateText,
-    addNewItem,
-    loading,
-    selectionVariant,
-    filterFn = getDefaultItemFilter(inputValue),
-    "aria-labelledby": ariaLabelledBy,
-    onOpenChange,
-    onSelectedChange = getDefaultOnSelectionChange(setInputValue),
-    customScrollContainerRef
-  } = props;
-  const listContainerRef = useRef(null);
-  const [highlightedItem, setHighlightedItem] = useState();
-  const [sortedItemIds, setSortedItemIds] = useState(items.map(({
-    id
-  }) => id));
-
-  const isItemSelected = itemId => selectedItemIds.includes(itemId);
-
-  const getItemById = itemId => items.find(item => item.id === itemId);
-
-  const selectableItems = 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];
-        onSelectedChange && onSelectedChange(newSelectedItemIds.map(getItemById));
-
-        if (selectionVariant === 'multiple') {
-          setInputValue && setInputValue('');
-          setAutocompleteSuggestion && setAutocompleteSuggestion('');
-        } else {
-          var _inputRef$current;
-
-          setShowMenu && setShowMenu(false);
-          inputRef === null || inputRef === void 0 ? void 0 : (_inputRef$current = inputRef.current) === null || _inputRef$current === void 0 ? void 0 : _inputRef$current.setSelectionRange(inputRef.current.value.length, inputRef.current.value.length);
-        }
-      }
-    };
-  });
-  const itemSortOrderData = sortedItemIds.reduce((acc, curr, i) => {
-    acc[curr] = i;
-    return acc;
-  }, {});
-  const sortedAndFilteredItemsToRender = selectableItems.filter((item, i) => filterFn(item, i)).sort((a, b) => itemSortOrderData[a.id] - itemSortOrderData[b.id]);
-  const allItemsToRender = [// 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, e) => {
-      // TODO: make it possible to pass a leadingVisual when using `addNewItem`
-      addNewItem.handleAddItem({ ...item,
-        id: item.id || uniqueId(),
-        leadingVisual: undefined
-      });
-
-      if (selectionVariant === 'multiple') {
-        setInputValue && setInputValue('');
-        setAutocompleteSuggestion && setAutocompleteSuggestion('');
-      }
-    }
-  }] : [])];
-  useFocusZone({
-    containerRef: listContainerRef,
-    focusOutBehavior: 'wrap',
-    focusableElementFilter: element => {
-      return !(element instanceof HTMLInputElement);
-    },
-    activeDescendantFocus: inputRef,
-    onActiveDescendantChanged: (current, _previous, directlyActivated) => {
-      if (activeDescendantRef) {
-        activeDescendantRef.current = current || null;
-      }
-
-      if (current) {
-        const selectedItem = selectableItems.find(item => item.id.toString() === (current === null || current === void 0 ? void 0 : current.dataset.id));
-        setHighlightedItem(selectedItem);
-        setIsMenuDirectlyActivated && setIsMenuDirectlyActivated(directlyActivated);
-      }
-
-      if (current && customScrollContainerRef && customScrollContainerRef.current && directlyActivated) {
-        scrollIntoViewingArea(current, customScrollContainerRef.current);
-      } else if (current && scrollContainerRef && scrollContainerRef.current && directlyActivated) {
-        scrollIntoViewingArea(current, scrollContainerRef.current);
-      }
-    }
-  }, [loading]);
-  useEffect(() => {
-    var _highlightedItem$text;
-
-    if (!setAutocompleteSuggestion) {
-      return;
-    }
-
-    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]);
-  useEffect(() => {
-    setSortedItemIds([...sortedItemIds].sort(sortOnCloseFn ? sortOnCloseFn : getDefaultSortFn(isItemSelected)));
-    onOpenChange && onOpenChange(Boolean(showMenu));
-  }, [showMenu]);
-  useEffect(() => {
-    setSelectedItemLength && setSelectedItemLength(selectedItemIds.length);
-  }, [selectedItemIds]);
-
-  if (listContainerRef.current) {
-    registerPortalRoot(listContainerRef.current, DROPDOWN_PORTAL_CONTAINER_NAME);
-  }
-
-  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

@@ -1,17 +0,0 @@
-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 const AutocompleteOverlay: React.FC<AutocompleteOverlayInternalProps>;
-export declare type AutocompleteOverlayProps = ComponentProps<typeof AutocompleteOverlay>;
-export default AutocompleteOverlay;

package/lib-esm/Autocomplete/AutocompleteOverlay.js

@@ -1,53 +0,0 @@
-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, { 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
-const AutocompleteOverlay = ({
-  menuAnchorRef,
-  overlayProps,
-  children
-}) => {
-  const {
-    inputRef,
-    scrollContainerRef,
-    selectedItemLength,
-    setShowMenu,
-    showMenu = false
-  } = useContext(AutocompleteContext);
-  const {
-    floatingElementRef,
-    position
-  } = useAnchoredPosition({
-    side: 'outside-bottom',
-    align: 'start',
-    anchorElementRef: menuAnchorRef ? menuAnchorRef : inputRef
-  }, [showMenu, selectedItemLength]);
-  const combinedOverlayRef = useCombinedRefs(scrollContainerRef, floatingElementRef);
-
-  const closeOptionList = () => {
-    setShowMenu && setShowMenu(false);
-  };
-
-  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

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

package/lib-esm/Autocomplete/index.js

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

package/lib-esm/TextInputWithTokens.d.ts

@@ -1,43 +0,0 @@
-import React, { ComponentPropsWithoutRef } from 'react';
-import { ComponentProps, MandateProps } from './utils/types';
-import Token, { TokenProps } from './Token/Token';
-import TokenLabel, { TokenLabelProps } from './Token/TokenLabel';
-import TokenProfile, { TokenProfileProps } from './Token/TokenProfile';
-import { TokenSizeKeys } from './Token/TokenBase';
-import { TextInputProps } from './TextInput';
-declare type AnyTokenProps = Partial<TokenProps & TokenLabelProps & TokenProfileProps>;
-declare type TokenDatum = MandateProps<AnyTokenProps, 'id' | 'text'>;
-declare type TextInputWithTokensInternalProps = {
-    /**
-     * The array of tokens to render
-     */
-    tokens: TokenDatum[];
-    /**
-     * The function that gets called when a token is removed
-     */
-    onTokenRemove: (tokenId: string | number) => void;
-    /**
-     * The component used to render each token
-     */
-    tokenComponent?: React.ComponentType<ComponentPropsWithoutRef<typeof Token> | ComponentPropsWithoutRef<typeof TokenLabel> | ComponentPropsWithoutRef<typeof TokenProfile>>;
-    /**
-     * The maximum height of the component. If the content in the input exceeds this height,
-     * it will scroll vertically
-     */
-    maxHeight?: React.CSSProperties['maxHeight'];
-    /**
-     * Whether tokens should render inline horizontally. By default, tokens wrap to new lines.
-     */
-    preventTokenWrapping?: boolean;
-    /**
-     * The size of the tokens
-     */
-    tokenSizeVariant?: TokenSizeKeys;
-    /**
-     * Whether the remove buttons should be rendered in the tokens
-     */
-    hideTokenRemoveButtons?: boolean;
-} & TextInputProps;
-declare const TextInputWithTokens: React.ForwardRefExoticComponent<Pick<TextInputWithTokensInternalProps, string | number | symbol> & React.RefAttributes<HTMLInputElement>>;
-export declare type TextInputWithTokensProps = ComponentProps<typeof TextInputWithTokens>;
-export default TextInputWithTokens;