@primer/components 0.0.0-202182720420 → 0.0.0-202182722258

package/lib/utils/types.d.ts

@@ -12,3 +12,6 @@ export declare type ComponentProps<T> = T extends React.ComponentType<infer Prop
  */
 export declare type Flatten<T extends unknown> = T extends (infer U)[] ? U : never;
 export declare type AriaRole = 'alert' | 'alertdialog' | 'application' | 'article' | 'banner' | 'button' | 'cell' | 'checkbox' | 'columnheader' | 'combobox' | 'complementary' | 'contentinfo' | 'definition' | 'dialog' | 'directory' | 'document' | 'feed' | 'figure' | 'form' | 'grid' | 'gridcell' | 'group' | 'heading' | 'img' | 'link' | 'list' | 'listbox' | 'listitem' | 'log' | 'main' | 'marquee' | 'math' | 'menu' | 'menubar' | 'menuitem' | 'menuitemcheckbox ' | 'menuitemradio' | 'navigation' | 'none' | 'note' | 'option' | 'presentation' | 'progressbar' | 'radio' | 'radiogroup' | 'region' | 'row' | 'rowgroup' | 'rowheader' | 'scrollbar' | 'search' | 'searchbox' | 'separator' | 'slider' | 'spinbutton' | 'status' | 'switch' | 'tab' | 'table' | 'tablist' | 'tabpanel' | 'term' | 'textbox' | 'timer' | 'toolbar' | 'tooltip' | 'tree' | 'treegrid' | 'treeitem';
+export declare type MandateProps<T extends {}, K extends keyof T> = Omit<T, K> & {
+    [MK in K]-?: NonNullable<T[MK]>;
+};

package/lib/utils/uniqueId.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.uniqueId = uniqueId;
-// Note: uniqueId may be unsafe in SSR contexts if it is used create DOM IDs or otherwise cause a hydration warning. Use useSSRSafeId instead.
 let idSeed = 10000;
 
 function uniqueId() {

package/lib-esm/ActionList/Divider.js

@@ -4,7 +4,7 @@ import { get } from '../constants';
 export const StyledDivider = styled.div.withConfig({
   displayName: "Divider__StyledDivider",
   componentId: "sc-42656i-0"
-})(["height:1px;background:", ";margin-top:calc(", " - 1px);margin-bottom:", ";"], get('colors.border.muted'), get('space.2'), get('space.2'));
+})(["height:1px;background:", ";margin-top:calc(", " - 1px);margin-bottom:", ";"], get('colors.selectMenu.borderSecondary'), get('space.2'), get('space.2'));
 /**
  * Visually separates `Item`s or `Group`s in an `ActionList`.
  */

package/lib-esm/ActionList/Header.js

@@ -11,9 +11,9 @@ import sx from '../sx';
 export const StyledHeader = styled.div.withConfig({
   displayName: "Header__StyledHeader",
   componentId: "qmofje-0"
-})(["{}padding:6px ", ";font-size:", ";font-weight:", ";color:", ";", " ", ""], get('space.3'), get('fontSizes.0'), get('fontWeights.bold'), get('colors.fg.muted'), ({
+})(["{}padding:6px ", ";font-size:", ";font-weight:", ";color:", ";", " ", ""], get('space.3'), get('fontSizes.0'), get('fontWeights.bold'), get('colors.text.secondary'), ({
   variant
-}) => variant === 'filled' && css(["background:", ";margin:", " 0;border-top:1px solid ", ";border-bottom:1px solid ", ";&:first-child{margin-top:0;}"], get('colors.canvas.subtle'), get('space.2'), get('colors.neutral.muted'), get('colors.neutral.muted')), sx);
+}) => variant === 'filled' && css(["background:", ";margin:", " 0;border-top:1px solid ", ";border-bottom:1px solid ", ";&:first-child{margin-top:0;}"], get('colors.bg.tertiary'), get('space.2'), get('colors.border.tertiary'), get('colors.border.tertiary')), sx);
 /**
  * Displays the name and description of a `Group`.
  */

package/lib-esm/ActionList/Item.js

@@ -1,7 +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 { CheckIcon } from '@primer/octicons-react';
-import React, { useCallback } from 'react';
+import React, { useCallback, useMemo } from 'react';
 import { get } from '../constants';
 import sx from '../sx';
 import Truncate from '../Truncate';
@@ -10,7 +10,7 @@ import { StyledHeader } from './Header';
 import { StyledDivider } from './Divider';
 import { useColorSchemeVar, useTheme } from '../ThemeProvider';
 import { activeDescendantActivatedDirectly, activeDescendantActivatedIndirectly, isActiveDescendantAttribute } from '../behaviors/focusZone';
-import { useSSRSafeId } from '@react-aria/ssr';
+import { uniqueId } from '../utils/uniqueId';
 /**
  * These colors are not yet in our default theme.  Need to remove this once they are added.
  */
@@ -48,9 +48,9 @@ const customItemThemes = {
 const getItemVariant = (variant = 'default', disabled) => {
   if (disabled) {
     return {
-      color: get('colors.fg.muted'),
-      iconColor: get('colors.fg.muted'),
-      annotationColor: get('colors.fg.muted'),
+      color: get('colors.text.disabled'),
+      iconColor: get('colors.text.disabled'),
+      annotationColor: get('colors.text.disabled'),
       hoverCursor: 'default'
     };
   }
@@ -58,17 +58,17 @@ const getItemVariant = (variant = 'default', disabled) => {
   switch (variant) {
     case 'danger':
       return {
-        color: get('colors.danger.fg'),
-        iconColor: get('colors.danger.fg'),
-        annotationColor: get('colors.fg.muted'),
+        color: get('colors.text.danger'),
+        iconColor: get('colors.icon.danger'),
+        annotationColor: get('colors.text.disabled'),
         hoverCursor: 'pointer'
       };
 
     default:
       return {
         color: 'inherit',
-        iconColor: get('colors.fg.muted'),
-        annotationColor: get('colors.fg.muted'),
+        iconColor: get('colors.text.secondary'),
+        annotationColor: get('colors.text.secondary'),
         hoverCursor: 'pointer'
       };
   }
@@ -95,7 +95,7 @@ const StyledItem = styled.div.withConfig({
   item
 }) => getItemVariant(variant, item === null || item === void 0 ? void 0 : item.disabled).hoverCursor, StyledDivider, StyledHeader, ({
   showDivider
-}) => showDivider ? `1px` : '0', DividedContent, get('colors.border.muted'), ({
+}) => showDivider ? `1px` : '0', DividedContent, get('colors.selectMenu.borderSecondary'), ({
   showDivider
 }) => showDivider ? `1px` : '0', DividedContent, DividedContent, DividedContent, DividedContent, isActiveDescendantAttribute, DividedContent, isActiveDescendantAttribute, DividedContent, isActiveDescendantAttribute, activeDescendantActivatedDirectly, ({
   focusBackground
@@ -135,7 +135,7 @@ const TrailingContent = styled(ColoredVisualContainer).withConfig({
 const DescriptionContainer = styled.span.withConfig({
   displayName: "Item__DescriptionContainer",
   componentId: "jqpvy8-8"
-})(["color:", ";font-size:", ";line-height:16px;margin-left:var(--description-container-margin-left);min-width:0;flex-grow:1;flex-basis:var(--description-container-flex-basis);"], get('colors.fg.muted'), get('fontSizes.0'));
+})(["color:", ";font-size:", ";line-height:16px;margin-left:var(--description-container-margin-left);min-width:0;flex-grow:1;flex-basis:var(--description-container-flex-basis);"], get('colors.text.secondary'), get('fontSizes.0'));
 const MultiSelectInput = styled.input.withConfig({
   displayName: "Item__MultiSelectInput",
   componentId: "jqpvy8-9"
@@ -164,8 +164,8 @@ export function Item(itemProps) {
     id,
     ...props
   } = itemProps;
-  const labelId = useSSRSafeId();
-  const descriptionId = useSSRSafeId();
+  const labelId = useMemo(() => uniqueId(), []);
+  const descriptionId = useMemo(() => uniqueId(), []);
   const keyPressHandler = useCallback(event => {
     if (disabled) {
       return;

package/lib-esm/ActionList/List.js

@@ -23,7 +23,7 @@ function isGroupedListProps(props) {
 const StyledList = styled.div.withConfig({
   displayName: "List__StyledList",
   componentId: "yr2k7d-0"
-})(["font-size:", ";line-height:20px;&[", "],&:focus-within{--item-hover-bg-override:none;--item-hover-divider-border-color-override:", ";}"], get('fontSizes.1'), hasActiveDescendantAttribute, get('colors.border.muted'));
+})(["font-size:", ";line-height:20px;&[", "],&:focus-within{--item-hover-bg-override:none;--item-hover-divider-border-color-override:", ";}"], get('fontSizes.1'), hasActiveDescendantAttribute, get('colors.selectMenu.borderSecondary'));
 /**
  * Returns `sx` prop values for `List` children matching the given `List` style variation.
  * @param variant `List` style variation.

package/lib-esm/AnchoredOverlay/AnchoredOverlay.js

@@ -1,11 +1,11 @@
 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 } from 'react';
+import React, { useCallback, useEffect, useMemo } from 'react';
 import Overlay from '../Overlay';
 import { useFocusTrap } from '../hooks/useFocusTrap';
 import { useFocusZone } from '../hooks/useFocusZone';
 import { useAnchoredPosition, useProvidedRefOrCreate, useRenderForcingRef } from '../hooks';
-import { useSSRSafeId } from '@react-aria/ssr';
+import { uniqueId } from '../utils/uniqueId';
 
 /**
  * An `AnchoredOverlay` provides an anchor that will open a floating overlay positioned relative to the anchor.
@@ -26,7 +26,7 @@ export const AnchoredOverlay = ({
 }) => {
   const anchorRef = useProvidedRefOrCreate(externalAnchorRef);
   const [overlayRef, updateOverlayRef] = useRenderForcingRef();
-  const anchorId = useSSRSafeId();
+  const anchorId = useMemo(uniqueId, []);
   const onClickOutside = useCallback(() => onClose === null || onClose === void 0 ? void 0 : onClose('click-outside'), [onClose]);
   const onEscape = useCallback(() => onClose === null || onClose === void 0 ? void 0 : onClose('escape'), [onClose]);
   const onAnchorKeyDown = useCallback(event => {

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

@@ -0,0 +1,26 @@
+import React from 'react';
+import { ComponentProps } from '../utils/types';
+import AutocompleteMenu from './AutocompleteMenu';
+declare const Autocomplete: React.FC;
+export declare type AutocompleteProps = ComponentProps<typeof Autocomplete>;
+export type { AutocompleteInputProps } from './AutocompleteInput';
+export type { AutocompleteMenuProps } from './AutocompleteMenu';
+declare const _default: React.FC<{}> & {
+    AutocompleteContext: React.Context<{
+        activeDescendantRef?: React.MutableRefObject<HTMLElement | null> | undefined;
+        autocompleteSuggestion?: string | undefined;
+        inputRef?: React.MutableRefObject<HTMLInputElement | null> | undefined;
+        inputValue?: string | undefined;
+        showMenu?: boolean | undefined;
+        setAutocompleteSuggestion?: React.Dispatch<React.SetStateAction<string>> | undefined;
+        setShowMenu?: React.Dispatch<React.SetStateAction<boolean>> | undefined;
+        setInputValue?: React.Dispatch<React.SetStateAction<string>> | undefined;
+        isMenuDirectlyActivated?: boolean | undefined;
+        setIsMenuDirectlyActivated?: React.Dispatch<React.SetStateAction<boolean>> | undefined;
+    }>;
+    Input: import("@radix-ui/react-polymorphic").ForwardRefComponent<"input", {
+        as?: React.ComponentType<any> | undefined;
+    }>;
+    Menu: typeof AutocompleteMenu;
+};
+export default _default;

package/lib-esm/Autocomplete/Autocomplete.js

@@ -0,0 +1,36 @@
+import React, { useRef, useState } from 'react';
+import { AutocompleteContext } from './AutocompleteContext';
+import AutocompleteInput from './AutocompleteInput';
+import AutocompleteMenu from './AutocompleteMenu';
+
+const Autocomplete = ({
+  children
+}) => {
+  const activeDescendantRef = useRef(null);
+  const inputRef = useRef(null);
+  const [inputValue, setInputValue] = useState('');
+  const [showMenu, setShowMenu] = useState(false);
+  const [autocompleteSuggestion, setAutocompleteSuggestion] = useState('');
+  const [isMenuDirectlyActivated, setIsMenuDirectlyActivated] = useState(false);
+  return /*#__PURE__*/React.createElement(AutocompleteContext.Provider, {
+    value: {
+      activeDescendantRef,
+      autocompleteSuggestion,
+      inputRef,
+      inputValue,
+      isMenuDirectlyActivated,
+      setAutocompleteSuggestion,
+      setInputValue,
+      setIsMenuDirectlyActivated,
+      setShowMenu,
+      showMenu
+    }
+  }, children);
+};
+
+Autocomplete.displayName = "Autocomplete";
+export default Object.assign(Autocomplete, {
+  AutocompleteContext,
+  Input: AutocompleteInput,
+  Menu: AutocompleteMenu
+});

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

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+export declare const AutocompleteContext: import("react").Context<{
+    activeDescendantRef?: import("react").MutableRefObject<HTMLElement | null> | undefined;
+    autocompleteSuggestion?: string | undefined;
+    inputRef?: import("react").MutableRefObject<HTMLInputElement | null> | undefined;
+    inputValue?: string | undefined;
+    showMenu?: boolean | undefined;
+    setAutocompleteSuggestion?: import("react").Dispatch<import("react").SetStateAction<string>> | undefined;
+    setShowMenu?: import("react").Dispatch<import("react").SetStateAction<boolean>> | undefined;
+    setInputValue?: import("react").Dispatch<import("react").SetStateAction<string>> | undefined;
+    isMenuDirectlyActivated?: boolean | undefined;
+    setIsMenuDirectlyActivated?: import("react").Dispatch<import("react").SetStateAction<boolean>> | undefined;
+}>;

package/lib-esm/Autocomplete/AutocompleteContext.js

@@ -0,0 +1,6 @@
+import { createContext } from 'react'; // TODO:
+// - figure out how we can make all of these properties required without having to define them when calling `createContext`
+// - figure out how we can reduce the number of properties that need to be passed
+// COLEHELP
+
+export const AutocompleteContext = /*#__PURE__*/createContext({});

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

@@ -0,0 +1,9 @@
+import React from 'react';
+import type * as Polymorphic from "@radix-ui/react-polymorphic";
+import { ComponentProps } from '../utils/types';
+declare type InternalAutocompleteInputProps = {
+    as?: React.ComponentType<any>;
+};
+declare const AutocompleteInput: Polymorphic.ForwardRefComponent<"input", InternalAutocompleteInputProps>;
+export declare type AutocompleteInputProps = ComponentProps<typeof AutocompleteInput>;
+export default AutocompleteInput;

package/lib-esm/Autocomplete/AutocompleteInput.js

@@ -0,0 +1,120 @@
+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 = '',
+    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
+    // COLEHELP
+
+    setTimeout(() => {
+      if (setShowMenu && document.activeElement !== combinedInputRef.current) {
+        setShowMenu(false);
+      }
+    }, 0);
+  };
+
+  const handleInputChange = e => {
+    if (onChange) {
+      onChange(e);
+    }
+
+    if (setInputValue) {
+      setInputValue(e.currentTarget.value);
+    }
+
+    if (setShowMenu && !showMenu) {
+      setShowMenu(true);
+    }
+  };
+
+  const handleInputKeyDown = e => {
+    if (e.key === 'Backspace') {
+      setHighlightRemainingText(false);
+    }
+  };
+
+  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
+    // COLEHELP
+
+
+    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
+  }, props));
+});
+export default AutocompleteInput;

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

@@ -0,0 +1,67 @@
+import React from 'react';
+import { ItemProps } from '../ActionList';
+import { OverlayProps } from '../Overlay';
+import { ComponentProps, MandateProps } from '../utils/types';
+declare type OnAction<T> = (item: T, event: React.MouseEvent<HTMLDivElement> | React.KeyboardEvent<HTMLDivElement>) => void;
+declare type AutocompleteMenuInternalProps<T extends MandateProps<ItemProps, 'id'>> = {
+    /**
+     * 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[];
+    /**
+     * The function that is called when an item in the list is de-selected
+     */
+    onItemDeselect?: OnAction<T>;
+    /**
+     * The function that is called when an item in the list is selected
+     */
+    onItemSelect?: OnAction<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.
+     */
+    selectedSortFn?: (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';
+    /**
+     * 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<Element>;
+};
+declare function AutocompleteMenu<T extends MandateProps<ItemProps, 'id'>>(props: AutocompleteMenuInternalProps<T> & Pick<OverlayProps, 'width' | 'height' | 'maxHeight'>): JSX.Element;
+declare namespace AutocompleteMenu {
+    var defaultProps: {
+        emptyStateText: string;
+        selectionVariant: string;
+    };
+    var displayName: string;
+}
+export declare type AutocompleteMenuProps = ComponentProps<typeof AutocompleteMenu>;
+export default AutocompleteMenu;