@primer/components 0.0.0-2021103235619 → 0.0.0-2021104151625

package/lib/theme-preval.js

@@ -1,5 +1,6 @@
 // this file was prevaled
 // This file needs to be a JavaScript file using CommonJS to be compatiable with preval
+// Cache bust: 2021-11-04 12:00:00 GMT (This file is cached by our deployment tooling, update this timestamp to rebuild this file)
 module.exports = {
   "theme": {
     "animation": {
@@ -389,6 +390,19 @@ module.exports = {
             "icon": "#6e7781",
             "borderHover": "rgba(175,184,193,0.2)"
           },
+          "actionListItem": {
+            "inlineDivider": "rgba(208,215,222,0.48)",
+            "default": {
+              "hoverBg": "rgba(208,215,222,0.32)",
+              "activeBg": "rgba(208,215,222,0.48)",
+              "selectedBg": "rgba(208,215,222,0.24)"
+            },
+            "danger": {
+              "hoverBg": "rgba(255,235,233,0.64)",
+              "activeBg": "#FFEBE9",
+              "hoverText": "#cf222e"
+            }
+          },
           "fg": {
             "default": "#24292f",
             "muted": "#57606a",
@@ -872,6 +886,19 @@ module.exports = {
             "icon": "#6e7781",
             "borderHover": "rgba(175,184,193,0.2)"
           },
+          "actionListItem": {
+            "inlineDivider": "rgba(208,215,222,0.48)",
+            "default": {
+              "hoverBg": "rgba(208,215,222,0.32)",
+              "activeBg": "rgba(208,215,222,0.48)",
+              "selectedBg": "rgba(208,215,222,0.24)"
+            },
+            "danger": {
+              "hoverBg": "rgba(254,254,72,0.64)",
+              "activeBg": "#fefe48",
+              "hoverText": "#ac5e00"
+            }
+          },
           "fg": {
             "default": "#24292f",
             "muted": "#57606a",
@@ -1355,6 +1382,19 @@ module.exports = {
             "icon": "#484f58",
             "borderHover": "rgba(110,118,129,0.4)"
           },
+          "actionListItem": {
+            "inlineDivider": "rgba(48,54,61,0.48)",
+            "default": {
+              "hoverBg": "rgba(177,186,196,0.12)",
+              "activeBg": "rgba(177,186,196,0.2)",
+              "selectedBg": "rgba(177,186,196,0.08)"
+            },
+            "danger": {
+              "hoverBg": "rgba(248,81,73,0.16)",
+              "activeBg": "rgba(248,81,73,0.24)",
+              "hoverText": "#ff7b72"
+            }
+          },
           "fg": {
             "default": "#c9d1d9",
             "muted": "#8b949e",
@@ -1841,6 +1881,19 @@ module.exports = {
             "icon": "#545d68",
             "borderHover": "rgba(99,110,123,0.4)"
           },
+          "actionListItem": {
+            "inlineDivider": "rgba(68,76,86,0.48)",
+            "default": {
+              "hoverBg": "rgba(144,157,171,0.12)",
+              "activeBg": "rgba(144,157,171,0.2)",
+              "selectedBg": "rgba(144,157,171,0.08)"
+            },
+            "danger": {
+              "hoverBg": "rgba(229,83,75,0.16)",
+              "activeBg": "rgba(229,83,75,0.24)",
+              "hoverText": "#f47067"
+            }
+          },
           "fg": {
             "default": "#adbac7",
             "muted": "#768390",
@@ -2327,6 +2380,19 @@ module.exports = {
             "icon": "#f0f3f6",
             "borderHover": "#bdc4cc"
           },
+          "actionListItem": {
+            "inlineDivider": "#7a828e",
+            "default": {
+              "hoverBg": "rgba(217,222,227,0.12)",
+              "activeBg": "rgba(217,222,227,0.24)",
+              "selectedBg": "rgba(217,222,227,0.08)"
+            },
+            "danger": {
+              "hoverBg": "#ff6a69",
+              "activeBg": "#ff4445",
+              "hoverText": "#0a0c10"
+            }
+          },
           "fg": {
             "default": "#f0f3f6",
             "muted": "#f0f3f6",
@@ -2813,6 +2879,19 @@ module.exports = {
             "icon": "#484f58",
             "borderHover": "rgba(110,118,129,0.4)"
           },
+          "actionListItem": {
+            "inlineDivider": "rgba(48,54,61,0.48)",
+            "default": {
+              "hoverBg": "rgba(177,186,196,0.12)",
+              "activeBg": "rgba(177,186,196,0.2)",
+              "selectedBg": "rgba(177,186,196,0.08)"
+            },
+            "danger": {
+              "hoverBg": "rgba(195,128,0,0.16)",
+              "activeBg": "rgba(195,128,0,0.24)",
+              "hoverText": "#d69a00"
+            }
+          },
           "fg": {
             "default": "#c9d1d9",
             "muted": "#8b949e",

package/lib/theme.d.ts

@@ -1,2 +1,80 @@
 import { theme } from './theme-preval';
+import { KeyPaths } from './utils/types/KeyPaths';
 export default theme;
+declare type ThemeColors = {
+    fg: {
+        default: string;
+        muted: string;
+        subtle: string;
+        onEmphasis: string;
+    };
+    canvas: {
+        default: string;
+        overlay: string;
+        inset: string;
+        subtle: string;
+    };
+    border: {
+        default: string;
+        muted: string;
+        subtle: string;
+    };
+    neutral: {
+        emphasisPlus: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    accent: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    success: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    attention: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    severe: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    danger: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    done: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+    sponsors: {
+        fg: string;
+        emphasis: string;
+        muted: string;
+        subtle: string;
+    };
+};
+declare type ThemeShadows = {
+    shadow: {
+        small: string;
+        medium: string;
+        large: string;
+        extraLarge: string;
+    };
+};
+export declare type ThemeColorPaths = KeyPaths<ThemeColors>;
+export declare type ThemeShadowPaths = KeyPaths<ThemeShadows>;

package/lib/theme.js

@@ -7,5 +7,7 @@ exports.default = void 0;
 
 var _themePreval = require("./theme-preval");
 
-var _default = _themePreval.theme;
+var _default = _themePreval.theme; // NOTE: for now, ThemeColors and ThemeShadows are handcrafted types. It would be nice if these
+// were exports from primitives (or a different shape but derived from those exports).
+
 exports.default = _default;

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> | undefined;
+        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

@@ -434,6 +434,19 @@ export declare function render(component: React.ReactElement, theme?: {
             icon: string;
             borderHover: string;
         };
+        actionListItem: {
+            inlineDivider: string;
+            default: {
+                hoverBg: string;
+                activeBg: string;
+                selectedBg: string;
+            };
+            danger: {
+                hoverBg: string;
+                activeBg: string;
+                hoverText: string;
+            };
+        };
         fg: {
             default: string;
             muted: string;

package/lib/utils/types/KeyPaths.d.ts

@@ -0,0 +1,3 @@
+export declare type KeyPaths<O extends Record<string, unknown>> = {
+    [K in keyof O]: K extends string ? O[K] extends string ? `${K}` : `${K}.${KeyPaths<O[K]>}` : never;
+}[keyof O];

package/lib/utils/types/KeyPaths.js

@@ -0,0 +1 @@
+"use strict";

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/ActionList/Header.js

@@ -28,6 +28,6 @@ export function Header({
   return /*#__PURE__*/React.createElement(StyledHeader, _extends({
     role: "heading",
     variant: variant
-  }, props), title, auxiliaryText && /*#__PURE__*/React.createElement("span", null, "auxiliaryText"));
+  }, props), title, auxiliaryText && /*#__PURE__*/React.createElement("span", null, auxiliaryText));
 }
 Header.displayName = "Header";

package/lib-esm/ActionList/Item.d.ts

@@ -28,13 +28,19 @@ export interface ItemProps extends SxProp {
      */
     leadingVisual?: React.FunctionComponent<IconProps>;
     /**
+     * @deprecated Use `trailingVisual` instead
      * Icon (or similar) positioned after `Item` text.
      */
     trailingIcon?: React.FunctionComponent<IconProps>;
     /**
+     * @deprecated Use `trailingVisual` instead
      * Text positioned after `Item` text and optional trailing icon.
      */
     trailingText?: string;
+    /**
+     * Icon or text positioned after `Item` text.
+     */
+    trailingVisual?: React.ReactNode;
     /**
      * Style variations associated with various `Item` types.
      *

package/lib-esm/ActionList/Item.js

@@ -154,6 +154,7 @@ export const Item = /*#__PURE__*/React.forwardRef((itemProps, ref) => {
     selectionVariant,
     leadingVisual: LeadingVisual,
     trailingIcon: TrailingIcon,
+    trailingVisual: TrailingVisual,
     trailingText,
     variant = 'default',
     showDivider,
@@ -245,7 +246,10 @@ export const Item = /*#__PURE__*/React.forwardRef((itemProps, ref) => {
     title: description,
     inline: true,
     maxWidth: "100%"
-  }, description)) : null), TrailingIcon || trailingText ? /*#__PURE__*/React.createElement(TrailingContent, {
+  }, description)) : null), TrailingVisual ? /*#__PURE__*/React.createElement(TrailingContent, {
+    variant: variant,
+    disabled: disabled
+  }, typeof TrailingVisual === 'function' ? /*#__PURE__*/React.createElement(TrailingVisual, null) : TrailingVisual) : TrailingIcon || trailingText ? /*#__PURE__*/React.createElement(TrailingContent, {
     variant: variant,
     disabled: disabled
   }, trailingText, TrailingIcon && /*#__PURE__*/React.createElement(TrailingIcon, null)) : null));

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

@@ -0,0 +1,12 @@
+import React from 'react';
+import { SxProp } from '../sx';
+export declare type DescriptionProps = {
+    /**
+     * Secondary text style variations.
+     *
+     * - `"inline"` - Secondary text is positioned beside primary text.
+     * - `"block"` - Secondary text is positioned below primary text.
+     */
+    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,5 @@
+/// <reference types="react" />
+/**
+ * Visually separates `Item`s or `Group`s in an `ActionList`.
+ */
+export declare function Divider(): JSX.Element;

package/lib-esm/ActionList2/Divider.js

@@ -0,0 +1,23 @@
+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: "li",
+    role: "separator",
+    sx: {
+      height: 1,
+      backgroundColor: 'actionListItem.inlineDivider',
+      marginTop: theme => `calc(${get('space.2')(theme)} - 1px)`,
+      marginBottom: 2,
+      listStyle: 'none' // hide the ::marker inserted by browser's stylesheet
+
+    },
+    "data-component": "ActionList.Divider"
+  });
+}
+Divider.displayName = "Divider";

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import { SxProp } from '../sx';
+import { HeaderProps } from './Header';
+import { ListProps } from './List';
+export declare type GroupProps = HeaderProps & SxProp & {
+    selectionVariant?: ListProps['selectionVariant'] | false;
+};
+declare type ContextProps = Pick<GroupProps, 'selectionVariant'>;
+export declare const GroupContext: React.Context<ContextProps>;
+export declare const Group: React.FC<GroupProps>;
+export {};

package/lib-esm/ActionList2/Group.js

@@ -0,0 +1,40 @@
+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 from 'react';
+import Box from '../Box';
+import { Header } from './Header';
+export const GroupContext = /*#__PURE__*/React.createContext({});
+export const Group = ({
+  title,
+  variant,
+  auxiliaryText,
+  selectionVariant,
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "li",
+    sx: {
+      '&:not(:first-child)': {
+        marginTop: 2
+      },
+      listStyle: 'none',
+      // hide the ::marker inserted by browser's stylesheet
+      ...sx
+    }
+  }, props), title && /*#__PURE__*/React.createElement(Header, {
+    title: title,
+    variant: variant,
+    auxiliaryText: auxiliaryText
+  }), /*#__PURE__*/React.createElement(GroupContext.Provider, {
+    value: {
+      selectionVariant
+    }
+  }, /*#__PURE__*/React.createElement(Box, {
+    as: "ul",
+    sx: {
+      paddingInlineStart: 0
+    }
+  }, props.children)));
+};
+Group.displayName = "Group";

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

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import { SxProp } from '../sx';
+/**
+ * Contract for props passed to the `Header` component.
+ */
+export declare type HeaderProps = {
+    /**
+     * Style variations. Usage is discretionary.
+     *
+     * - `"filled"` - Superimposed on a background, offset from nearby content
+     * - `"subtle"` - Relatively less offset from nearby content
+     */
+    variant?: 'subtle' | 'filled';
+    /**
+     * Primary text which names a `Group`.
+     */
+    title?: string;
+    /**
+     * Secondary text which provides additional information about a `Group`.
+     */
+    auxiliaryText?: string;
+} & SxProp;
+/**
+ * Displays the name and description of a `Group`.
+ */
+export declare const Header: ({ variant, title, auxiliaryText, sx, ...props }: HeaderProps) => JSX.Element;

package/lib-esm/ActionList2/Header.js

@@ -0,0 +1,44 @@
+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 from 'react';
+import Box from '../Box';
+import { ListContext } from './List';
+/**
+ * Contract for props passed to the `Header` component.
+ */
+
+/**
+ * Displays the name and description of a `Group`.
+ */
+export const Header = ({
+  variant = 'subtle',
+  title,
+  auxiliaryText,
+  sx = {},
+  ...props
+}) => {
+  const {
+    variant: listVariant
+  } = React.useContext(ListContext);
+  const styles = {
+    paddingY: '6px',
+    paddingX: listVariant === 'full' ? 2 : 3,
+    fontSize: 0,
+    fontWeight: 'bold',
+    color: 'fg.muted',
+    ...(variant === 'filled' && {
+      backgroundColor: 'canvas.subtle',
+      marginX: 0,
+      marginBottom: 2,
+      borderTop: '1px solid',
+      borderBottom: '1px solid',
+      borderColor: 'neutral.muted'
+    }),
+    ...sx
+  };
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    sx: styles,
+    role: "heading"
+  }, props), title, auxiliaryText && /*#__PURE__*/React.createElement("span", null, auxiliaryText));
+};
+Header.displayName = "Header";