@primer/components 0.0.0-202192602912 → 0.0.0-2021926114132

package/lib/ActionList2/Visuals.js

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TrailingVisual = exports.LeadingVisual = exports.LeadingVisualContainer = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _sx = require("../sx");
+
+var _constants = require("../constants");
+
+var _Item = require("./Item");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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); }
+
+const LeadingVisualContainer = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "span",
+    sx: (0, _sx.merge)({
+      height: '20px',
+      // match height of text row
+      minWidth: (0, _constants.get)('space.3'),
+      maxWidth: '20px',
+      // square (same as height)
+      display: 'flex',
+      justifyContent: 'center',
+      alignItems: 'center',
+      flexShrink: 0,
+      marginRight: 2
+    }, sx)
+  }, props));
+};
+
+exports.LeadingVisualContainer = LeadingVisualContainer;
+LeadingVisualContainer.displayName = "LeadingVisualContainer";
+
+const LeadingVisual = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/_react.default.createElement(_Item.Slot, {
+    name: "LeadingVisual"
+  }, ({
+    variant,
+    disabled
+  }) => /*#__PURE__*/_react.default.createElement(LeadingVisualContainer, _extends({
+    sx: (0, _sx.merge)({
+      color: (0, _Item.getVariantStyles)(variant, disabled).iconColor,
+      svg: {
+        fontSize: 0
+      }
+    }, sx)
+  }, props), props.children));
+};
+
+exports.LeadingVisual = LeadingVisual;
+LeadingVisual.displayName = "LeadingVisual";
+
+const TrailingVisual = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/_react.default.createElement(_Item.Slot, {
+    name: "TrailingVisual"
+  }, ({
+    variant,
+    disabled
+  }) => /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "span",
+    sx: (0, _sx.merge)({
+      height: '20px',
+      // match height of text row
+      flexShrink: 0,
+      color: (0, _Item.getVariantStyles)(variant, disabled).annotationColor,
+      marginLeft: 2
+    }, sx)
+  }, props), props.children));
+};
+
+exports.TrailingVisual = TrailingVisual;
+TrailingVisual.displayName = "TrailingVisual";

package/lib/ActionList2/hacks.d.ts

@@ -0,0 +1,30 @@
+/**
+ * These colors are not yet in our default theme.
+ * TODO: Need to remove this once they are added.
+ */
+export declare const customItemThemes: {
+    default: {
+        hover: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+        focus: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+    };
+    danger: {
+        hover: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+        focus: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+    };
+};

package/lib/ActionList2/hacks.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.customItemThemes = void 0;
+
+/**
+ * These colors are not yet in our default theme.
+ * TODO: Need to remove this once they are added.
+ */
+const customItemThemes = {
+  default: {
+    hover: {
+      light: 'rgba(46, 77, 108, 0.06)',
+      dark: 'rgba(201, 206, 212, 0.12)',
+      dark_dimmed: 'rgba(201, 206, 212, 0.12)'
+    },
+    focus: {
+      light: 'rgba(54, 77, 100, 0.16)',
+      dark: 'rgba(201, 206, 212, 0.24)',
+      dark_dimmed: 'rgba(201, 206, 212, 0.24)'
+    }
+  },
+  danger: {
+    hover: {
+      light: 'rgba(234, 74, 90, 0.08)',
+      dark: 'rgba(248, 81, 73, 0.16)',
+      dark_dimmed: 'rgba(248, 81, 73, 0.16)'
+    },
+    focus: {
+      light: 'rgba(234, 74, 90, 0.14)',
+      dark: 'rgba(248, 81, 73, 0.24)',
+      dark_dimmed: 'rgba(248, 81, 73, 0.24)'
+    }
+  }
+};
+exports.customItemThemes = customItemThemes;

package/lib/ActionList2/index.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import { Group } from './Group';
+import { Divider } from './Divider';
+export type { ListProps as ActionListProps } from './List';
+export type { GroupProps } from './Group';
+export type { ItemProps } from './Item';
+export type { DescriptionProps } from './Description';
+export type { LeadingVisualProps, TrailingVisualProps } from './Visuals';
+/**
+ * Collection of list-related components.
+ */
+export declare const ActionList: import("@radix-ui/react-polymorphic").ForwardRefComponent<"ul", import("./List").ListProps> & {
+    /** Collects related `Items` in an `ActionList`. */
+    Group: typeof Group;
+    /** An actionable or selectable `Item` with an optional icon and description. */
+    Item: import("@radix-ui/react-polymorphic").ForwardRefComponent<"li", import("./Item").ItemProps>;
+    /** Visually separates `Item`s or `Group`s in an `ActionList`. */
+    Divider: typeof Divider;
+    Description: import("react").FC<import("./Description").DescriptionProps>;
+    LeadingVisual: import("react").FC<import("../sx").SxProp & {
+        children: import("react").ReactNode;
+    }>;
+    TrailingVisual: import("react").FC<import("../sx").SxProp & {
+        children: import("react").ReactNode;
+    }>;
+};

package/lib/ActionList2/index.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ActionList = void 0;
+
+var _List = require("./List");
+
+var _Group = require("./Group");
+
+var _Item = require("./Item");
+
+var _Divider = require("./Divider");
+
+var _Description = require("./Description");
+
+var _Visuals = require("./Visuals");
+
+/**
+ * Collection of list-related components.
+ */
+const ActionList = Object.assign(_List.List, {
+  /** Collects related `Items` in an `ActionList`. */
+  Group: _Group.Group,
+
+  /** An actionable or selectable `Item` with an optional icon and description. */
+  Item: _Item.Item,
+
+  /** Visually separates `Item`s or `Group`s in an `ActionList`. */
+  Divider: _Divider.Divider,
+  Description: _Description.Description,
+  LeadingVisual: _Visuals.LeadingVisual,
+  TrailingVisual: _Visuals.TrailingVisual
+});
+exports.ActionList = ActionList;

package/lib/AnchoredOverlay/AnchoredOverlay.d.ts

@@ -26,8 +26,6 @@ interface AnchoredOverlayPropsWithoutAnchor {
      */
     anchorRef: React.RefObject<HTMLElement>;
 }
-export declare type OverlayOpenGesture = 'anchor-click' | 'anchor-key-press';
-export declare type OverlayCloseGesture = 'anchor-click' | 'click-outside' | 'escape';
 export declare type AnchoredOverlayWrapperAnchorProps = Partial<AnchoredOverlayPropsWithAnchor> | AnchoredOverlayPropsWithoutAnchor;
 interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'> {
     /**
@@ -37,11 +35,11 @@ interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'
     /**
      * A callback which is called whenever the overlay is currently closed and an "open gesture" is detected.
      */
-    onOpen?: (gesture: OverlayOpenGesture) => unknown;
+    onOpen?: (gesture: 'anchor-click' | 'anchor-key-press') => unknown;
     /**
      * A callback which is called whenever the overlay is currently open and a "close gesture" is detected.
      */
-    onClose?: (gesture: OverlayCloseGesture) => unknown;
+    onClose?: (gesture: 'anchor-click' | 'click-outside' | 'escape') => unknown;
     /**
      * Props to be spread on the internal `Overlay` component.
      */

package/lib/Autocomplete/Autocomplete.d.ts

@@ -12,14 +12,12 @@ export type { AutocompleteOverlayProps } from './AutocompleteOverlay';
 declare const _default: React.FC<{
     id?: string | undefined;
 }> & {
-    Input: import("@radix-ui/react-polymorphic").ForwardRefComponent<React.ForwardRefExoticComponent<Pick<Omit<Pick<({
+    Input: import("@radix-ui/react-polymorphic").ForwardRefComponent<React.ForwardRefExoticComponent<Pick<Omit<Pick<{
         [x: string]: any;
         [x: number]: any;
     } & {
         theme?: any;
-    } & ({} | {
-        children?: React.ReactNode;
-    })) & {
+    } & {
         as?: string | React.ComponentType<any> | undefined;
         forwardedAs?: string | React.ComponentType<any> | undefined;
     }, string | number | symbol>, "maxWidth" | "minWidth" | "width" | "theme" | "className" | "block" | "icon" | "sx" | "disabled" | "variant" | "contrast"> & {

package/lib/Autocomplete/AutocompleteInput.d.ts

@@ -4,14 +4,12 @@ import { ComponentProps } from '../utils/types';
 declare type InternalAutocompleteInputProps = {
     as?: React.ComponentType<any>;
 };
-declare const AutocompleteInput: PolymorphicForwardRefComponent<React.ForwardRefExoticComponent<Pick<Omit<Pick<({
+declare const AutocompleteInput: PolymorphicForwardRefComponent<React.ForwardRefExoticComponent<Pick<Omit<Pick<{
     [x: string]: any;
     [x: number]: any;
 } & {
     theme?: any;
-} & ({} | {
-    children?: React.ReactNode;
-})) & {
+} & {
     as?: string | React.ComponentType<any> | undefined;
     forwardedAs?: string | React.ComponentType<any> | undefined;
 }, string | number | symbol>, "maxWidth" | "minWidth" | "width" | "theme" | "className" | "block" | "icon" | "sx" | "disabled" | "variant" | "contrast"> & {

package/lib/SelectMenu/SelectMenu.d.ts

@@ -32,14 +32,12 @@ declare const _default: React.ForwardRefExoticComponent<Pick<SelectMenuInternalP
     Divider: import("styled-components").StyledComponent<"div", any, SystemCommonProps & SxProp, never>;
     Filter: React.ForwardRefExoticComponent<Pick<{
         value?: string | undefined;
-    } & Pick<Omit<Pick<({
+    } & Pick<Omit<Pick<{
         [x: string]: any;
         [x: number]: any;
     } & {
         theme?: any;
-    } & ({} | {
-        children?: React.ReactNode;
-    })) & {
+    } & {
         as?: string | React.ComponentType<any> | undefined;
         forwardedAs?: string | React.ComponentType<any> | undefined;
     }, string | number | symbol>, "maxWidth" | "minWidth" | "width" | "theme" | "className" | "block" | "icon" | "sx" | "disabled" | "variant" | "contrast"> & {

package/lib/TextInputWithTokens.d.ts

@@ -32,14 +32,12 @@ declare const TextInputWithTokens: React.ForwardRefExoticComponent<Pick<{
      * Whether the remove buttons should be rendered in the tokens
      */
     hideTokenRemoveButtons?: boolean | undefined;
-} & Pick<Omit<Pick<({
+} & Pick<Omit<Pick<{
     [x: string]: any;
     [x: number]: any;
 } & {
     theme?: any;
-} & ({} | {
-    children?: React.ReactNode;
-})) & {
+} & {
     as?: string | React.ComponentType<any> | undefined;
     forwardedAs?: string | React.ComponentType<any> | undefined;
 }, string | number | symbol>, "maxWidth" | "minWidth" | "width" | "theme" | "className" | "block" | "icon" | "sx" | "disabled" | "variant" | "contrast"> & {

package/lib/index.d.ts

@@ -22,6 +22,7 @@ export { useOnEscapePress } from './hooks/useOnEscapePress';
 export { useOverlay } from './hooks/useOverlay';
 export { useConfirm } from './Dialog/ConfirmationDialog';
 export { ActionList } from './ActionList';
+export { ActionList as ActionList2 } from './ActionList2';
 export { ActionMenu } from './ActionMenu';
 export type { ActionMenuProps } from './ActionMenu';
 export { default as Autocomplete } from './Autocomplete';

package/lib/index.js

@@ -147,6 +147,12 @@ Object.defineProperty(exports, "ActionList", {
     return _ActionList.ActionList;
   }
 });
+Object.defineProperty(exports, "ActionList2", {
+  enumerable: true,
+  get: function () {
+    return _ActionList2.ActionList;
+  }
+});
 Object.defineProperty(exports, "ActionMenu", {
   enumerable: true,
   get: function () {
@@ -536,6 +542,8 @@ var _ConfirmationDialog = require("./Dialog/ConfirmationDialog");
 
 var _ActionList = require("./ActionList");
 
+var _ActionList2 = require("./ActionList2");
+
 var _ActionMenu = require("./ActionMenu");
 
 var _Autocomplete = _interopRequireDefault(require("./Autocomplete"));

package/lib/sx.d.ts

@@ -1,6 +1,8 @@
 import { SystemStyleObject } from '@styled-system/css';
+import merge from 'deepmerge';
 export interface SxProp {
     sx?: SystemStyleObject;
 }
 declare const sx: (props: SxProp) => import("@styled-system/css").CssFunctionReturnType;
 export default sx;
+export { merge };

package/lib/sx.js

@@ -3,10 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "merge", {
+  enumerable: true,
+  get: function () {
+    return _deepmerge.default;
+  }
+});
 exports.default = void 0;
 
 var _css = _interopRequireDefault(require("@styled-system/css"));
 
+var _deepmerge = _interopRequireDefault(require("deepmerge"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const sx = props => (0, _css.default)(props.sx);

package/lib/theme-preval.js

@@ -515,7 +515,7 @@ module.exports = {
           }
         }
       },
-      "light_colorblind": {
+      "light_protanopia": {
         "colors": {
           "canvasDefaultTransparent": "rgba(255,255,255,0)",
           "marketingIcon": {
@@ -2456,7 +2456,7 @@ module.exports = {
           }
         }
       },
-      "dark_colorblind": {
+      "dark_protanopia": {
         "colors": {
           "canvasDefaultTransparent": "rgba(13,17,23,0)",
           "marketingIcon": {

package/lib/utils/create-slots.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+/** createSlots is a factory that can create a
+ *  typesafe Slots + Slot pair to use in a component definition
+ *  For example: ActionList.Item uses createSlots to get a Slots wrapper
+ *  + Slot component that is used by LeadingVisual, Description
+ */
+declare const createSlots: <SlotNames extends string>(slotNames: SlotNames[]) => {
+    Slots: React.FC<{
+        context: Record<string, unknown>;
+        children: (slots: { [key in SlotNames]?: React.ReactNode; }) => React.ReactNode;
+    }>;
+    Slot: React.FC<{
+        name: SlotNames;
+        children: React.ReactNode | ((context: Record<string, unknown>) => React.ReactNode);
+    }>;
+};
+export default createSlots;

package/lib/utils/create-slots.js

@@ -0,0 +1,105 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _useForceUpdate = require("./use-force-update");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/** createSlots is a factory that can create a
+ *  typesafe Slots + Slot pair to use in a component definition
+ *  For example: ActionList.Item uses createSlots to get a Slots wrapper
+ *  + Slot component that is used by LeadingVisual, Description
+ */
+const createSlots = slotNames => {
+  const SlotsContext = /*#__PURE__*/_react.default.createContext({
+    registerSlot: () => null,
+    unregisterSlot: () => null,
+    context: {}
+  });
+  /** Slots uses a Double render strategy inspired by [reach-ui/descendants](https://github.com/reach/reach-ui/tree/develop/packages/descendants)
+   *  Slot registers themself with the Slots parent.
+   *  When all the children have mounted = registered themselves in slot,
+   *  we re-render the parent component to render with slots
+   */
+
+
+  const Slots = ({
+    context,
+    children
+  }) => {
+    // initialise slots
+    const slotsDefinition = {};
+    slotNames.map(name => slotsDefinition[name] = null);
+
+    const slotsRef = _react.default.useRef(slotsDefinition);
+
+    const rerenderWithSlots = (0, _useForceUpdate.useForceUpdate)();
+
+    const [isMounted, setIsMounted] = _react.default.useState(false); // fires after all the effects in children
+
+
+    _react.default.useEffect(() => {
+      rerenderWithSlots();
+      setIsMounted(true);
+    }, [rerenderWithSlots]);
+
+    const registerSlot = _react.default.useCallback((name, contents) => {
+      slotsRef.current[name] = contents; // don't render until the component mounts = all slots are registered
+
+      if (isMounted) rerenderWithSlots();
+    }, [isMounted, rerenderWithSlots]); // Slot can be removed from the tree as well,
+    // we need to unregister them from the slot
+
+
+    const unregisterSlot = _react.default.useCallback(name => {
+      slotsRef.current[name] = null;
+      rerenderWithSlots();
+    }, [rerenderWithSlots]);
+    /**
+     * Slots uses a render prop API so abstract the
+     * implementation detail of using a context provider.
+     */
+
+
+    const slots = slotsRef.current;
+    return /*#__PURE__*/_react.default.createElement(SlotsContext.Provider, {
+      value: {
+        registerSlot,
+        unregisterSlot,
+        context
+      }
+    }, children(slots));
+  };
+
+  const Slot = ({
+    name,
+    children
+  }) => {
+    const {
+      registerSlot,
+      unregisterSlot,
+      context
+    } = _react.default.useContext(SlotsContext);
+
+    _react.default.useEffect(() => {
+      registerSlot(name, typeof children === 'function' ? children(context) : children);
+      return () => unregisterSlot(name);
+    }, [name, children, registerSlot, unregisterSlot, context]);
+
+    return null;
+  };
+
+  return {
+    Slots,
+    Slot
+  };
+};
+
+var _default = createSlots;
+exports.default = _default;

package/lib/utils/testing.d.ts

@@ -53,7 +53,7 @@ export declare function render(component: React.ReactElement, theme?: {
         xlarge: string;
     };
     space: string[];
-    colorSchemes: Record<"light" | "light_colorblind" | "dark" | "dark_dimmed" | "dark_high_contrast" | "dark_colorblind", Record<"colors" | "shadows", Partial<{
+    colorSchemes: Record<"light" | "light_protanopia" | "dark" | "dark_dimmed" | "dark_high_contrast" | "dark_protanopia", Record<"colors" | "shadows", Partial<{
         canvasDefaultTransparent: string;
         marketingIcon: {
             primary: string;

package/lib/utils/use-force-update.d.ts

@@ -0,0 +1 @@
+export declare const useForceUpdate: () => () => void;

package/lib/utils/use-force-update.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useForceUpdate = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Inspired from reach-ui: https://github.com/reach/reach-ui/blob/develop/packages/utils/src/use-force-update.ts
+const useForceUpdate = () => {
+  const [, rerender] = _react.default.useState({});
+
+  return _react.default.useCallback(() => rerender({}), []);
+};
+
+exports.useForceUpdate = useForceUpdate;

package/lib-esm/ActionList2/Description.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { SxProp } from '../sx';
+export declare type DescriptionProps = {
+    variant?: 'inline' | 'block';
+} & SxProp;
+export declare const Description: React.FC<DescriptionProps>;

package/lib-esm/ActionList2/Description.js

@@ -0,0 +1,37 @@
+import React from 'react';
+import Box from '../Box';
+import { merge } from '../sx';
+import Truncate from '../Truncate';
+import { Slot } from './Item';
+export const Description = ({
+  variant = 'inline',
+  sx = {},
+  ...props
+}) => {
+  const styles = {
+    color: 'fg.muted',
+    fontSize: 0,
+    lineHeight: '16px',
+    flexGrow: 1,
+    flexBasis: 0,
+    minWidth: 0,
+    marginLeft: variant === 'block' ? 0 : 2
+  };
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: variant === 'block' ? 'BlockDescription' : 'InlineDescription'
+  }, ({
+    blockDescriptionId,
+    inlineDescriptionId
+  }) => variant === 'block' ? /*#__PURE__*/React.createElement(Box, {
+    as: "span",
+    sx: merge(styles, sx),
+    id: blockDescriptionId
+  }, props.children) : /*#__PURE__*/React.createElement(Truncate, {
+    id: inlineDescriptionId,
+    sx: merge(styles, sx),
+    title: props.children,
+    inline: true,
+    maxWidth: "100%"
+  }, props.children));
+};
+Description.displayName = "Description";

package/lib-esm/ActionList2/Divider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+/**
+ * Visually separates `Item`s or `Group`s in an `ActionList`.
+ */
+export declare function Divider(): JSX.Element;
+export declare namespace Divider {
+    var renderItem: typeof Divider;
+}

package/lib-esm/ActionList2/Divider.js

@@ -0,0 +1,30 @@
+import React from 'react';
+import Box from '../Box';
+import { get } from '../constants';
+
+/**
+ * Visually separates `Item`s or `Group`s in an `ActionList`.
+ */
+export function Divider() {
+  return /*#__PURE__*/React.createElement(Box, {
+    as: "hr",
+    sx: {
+      border: 'none',
+      // override browser styles
+      height: 1,
+      backgroundColor: 'border.muted',
+      marginTop: theme => `calc(${get('space.2')(theme)} - 1px)`,
+      marginBottom: 2
+    },
+    "data-component": "ActionList.Divider"
+  });
+}
+Divider.displayName = "Divider";
+
+/**
+ * `Divider` fulfills the `ItemPropsWithCustomRenderer` contract,
+ * so it can be used inline in an `ActionList`’s `items` prop.
+ * In other words, `items={[ActionList.Divider]}` is supported as a concise
+ * alternative to `items={[{renderItem: () => <ActionList.Divider />}]}`.
+ */
+Divider.renderItem = Divider;

package/lib-esm/ActionList2/Group.d.ts

@@ -0,0 +1,8 @@
+/**
+ * show item dividers
+ */
+/// <reference types="react" />
+import { SxProp } from '../sx';
+import { HeaderProps } from './Header';
+export declare type GroupProps = HeaderProps & SxProp;
+export declare function Group({ title, variant, auxiliaryText, sx, ...props }: GroupProps): JSX.Element;