@primer/components 31.2.0-rc.fbb10090 → 31.2.0

package/lib-esm/drafts.js

@@ -0,0 +1,9 @@
+/** This is the place where we keep components that are not part of the public
+ *  api yet (not in main bundle). We don't recommend using it in production.
+ *
+ *  But, they are published on npm and you can import them for experimentation/feedback.
+ *  example: import {ActionList} from '@primer/components/drafts
+ */
+// Components
+export * from './ActionList2';
+export * from './NewButton';

package/lib-esm/hooks/useAnchoredPosition.js

@@ -2,6 +2,7 @@ import React from 'react';
 import { getAnchoredPosition } from '../behaviors/anchoredPosition';
 import { useProvidedRefOrCreate } from './useProvidedRefOrCreate';
 import { useResizeObserver } from './useResizeObserver';
+import useLayoutEffect from '../utils/useIsomorphicLayoutEffect';
 
 /**
  * Calculates the top and left values for an absolutely-positioned floating element
@@ -24,7 +25,7 @@ export function useAnchoredPosition(settings, dependencies = []) {
     }
   }, // eslint-disable-next-line react-hooks/exhaustive-deps
   [floatingElementRef, anchorElementRef, ...dependencies]);
-  React.useLayoutEffect(updatePosition, [updatePosition]);
+  useLayoutEffect(updatePosition, [updatePosition]);
   useResizeObserver(updatePosition);
   return {
     floatingElementRef,

package/lib-esm/hooks/useCombinedRefs.d.ts

@@ -1,4 +1,4 @@
-import React, { ForwardedRef } from 'react';
+import { ForwardedRef } from 'react';
 /**
  * Creates a ref by combining multiple constituent refs. The ref returned by this hook
  * should be passed as the ref for the element that needs to be shared. This is
@@ -7,4 +7,4 @@ import React, { ForwardedRef } from 'react';
  * though, as it breaks encapsulation.
  * @param refs
  */
-export declare function useCombinedRefs<T>(...refs: (ForwardedRef<T> | null | undefined)[]): React.MutableRefObject<T | null>;
+export declare function useCombinedRefs<T>(...refs: (ForwardedRef<T> | null | undefined)[]): import("react").MutableRefObject<T | null>;

package/lib-esm/hooks/useCombinedRefs.js

@@ -1,4 +1,5 @@
-import React, { useRef } from 'react';
+import { useRef } from 'react';
+import useLayoutEffect from '../utils/useIsomorphicLayoutEffect';
 /**
  * Creates a ref by combining multiple constituent refs. The ref returned by this hook
  * should be passed as the ref for the element that needs to be shared. This is
@@ -10,7 +11,7 @@ import React, { useRef } from 'react';
 
 export function useCombinedRefs(...refs) {
   const combinedRef = useRef(null);
-  React.useLayoutEffect(() => {
+  useLayoutEffect(() => {
     function setRefs(current = null) {
       for (const ref of refs) {
         if (!ref) {

package/lib-esm/hooks/useResizeObserver.js

@@ -1,6 +1,6 @@
-import React from 'react';
+import useLayoutEffect from '../utils/useIsomorphicLayoutEffect';
 export function useResizeObserver(callback) {
-  React.useLayoutEffect(() => {
+  useLayoutEffect(() => {
     const observer = new window.ResizeObserver(() => callback());
     observer.observe(document.documentElement);
     return () => {

package/lib-esm/index.d.ts

@@ -37,6 +37,8 @@ export type { BranchNameProps } from './BranchName';
 export { default as Breadcrumbs, Breadcrumb } from './Breadcrumbs';
 export type { BreadcrumbsProps, BreadcrumbsItemProps, BreadcrumbProps, BreadcrumbItemProps } from './Breadcrumbs';
 export { default as Button, ButtonDanger, ButtonOutline, ButtonPrimary, ButtonInvisible, ButtonTableList, ButtonClose, ButtonGroup } from './Button';
+export { NewButton } from './NewButton';
+export type { NewButtonProps } from './NewButton';
 export type { ButtonProps, ButtonDangerProps, ButtonOutlineProps, ButtonPrimaryProps, ButtonInvisibleProps, ButtonTableListProps, ButtonCloseProps, ButtonGroupProps } from './Button';
 export { default as Caret } from './Caret';
 export type { CaretProps } from './Caret';

package/lib-esm/index.js

@@ -26,6 +26,7 @@ export { default as AvatarStack } from './AvatarStack';
 export { default as BranchName } from './BranchName';
 export { default as Breadcrumbs, Breadcrumb } from './Breadcrumbs';
 export { default as Button, ButtonDanger, ButtonOutline, ButtonPrimary, ButtonInvisible, ButtonTableList, ButtonClose, ButtonGroup } from './Button';
+export { NewButton } from './NewButton';
 export { default as Caret } from './Caret';
 export { default as CircleBadge } from './CircleBadge';
 export { default as CircleOcticon } from './CircleOcticon';

package/lib-esm/sx.d.ts

@@ -1,6 +1,7 @@
 import { SystemCssProperties, SystemStyleObject } from '@styled-system/css';
 import { ThemeColorPaths, ThemeShadowPaths } from './theme';
 import { ColorProps, ShadowProps } from 'styled-system';
+import merge from 'deepmerge';
 export declare type BetterCssProperties = {
     [K in keyof SystemCssProperties]: K extends keyof ColorProps ? ThemeColorPaths | SystemCssProperties[K] : K extends keyof ShadowProps ? ThemeShadowPaths | SystemCssProperties[K] : SystemCssProperties[K];
 };
@@ -10,3 +11,4 @@ export interface SxProp {
 }
 declare const sx: (props: SxProp) => import("@styled-system/css").CssFunctionReturnType;
 export default sx;
+export { merge };

package/lib-esm/sx.js

@@ -1,5 +1,7 @@
 import css from '@styled-system/css';
+import merge from 'deepmerge';
 
 const sx = props => css(props.sx);
 
-export default sx;
+export default sx;
+export { merge };

package/lib-esm/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",
@@ -515,7 +529,7 @@ module.exports = {
           }
         }
       },
-      "light_protanopia": {
+      "light_colorblind": {
         "colors": {
           "canvasDefaultTransparent": "rgba(255,255,255,0)",
           "marketingIcon": {
@@ -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",
@@ -2456,7 +2522,7 @@ module.exports = {
           }
         }
       },
-      "dark_protanopia": {
+      "dark_colorblind": {
         "colors": {
           "canvasDefaultTransparent": "rgba(13,17,23,0)",
           "marketingIcon": {
@@ -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-esm/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;
+    }>;
+};
+export default createSlots;

package/lib-esm/utils/create-slots.js

@@ -0,0 +1,84 @@
+import React from 'react';
+import { useForceUpdate } from './use-force-update';
+/** 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.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.useRef(slotsDefinition);
+    const rerenderWithSlots = useForceUpdate();
+    const [isMounted, setIsMounted] = React.useState(false); // fires after all the effects in children
+
+    React.useEffect(() => {
+      rerenderWithSlots();
+      setIsMounted(true);
+    }, [rerenderWithSlots]);
+    const registerSlot = React.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.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.createElement(SlotsContext.Provider, {
+      value: {
+        registerSlot,
+        unregisterSlot,
+        context
+      }
+    }, children(slots));
+  };
+
+  const Slot = ({
+    name,
+    children
+  }) => {
+    const {
+      registerSlot,
+      unregisterSlot,
+      context
+    } = React.useContext(SlotsContext);
+    React.useEffect(() => {
+      registerSlot(name, typeof children === 'function' ? children(context) : children);
+      return () => unregisterSlot(name);
+    }, [name, children, registerSlot, unregisterSlot, context]);
+    return null;
+  };
+
+  return {
+    Slots,
+    Slot
+  };
+};
+
+export default createSlots;

package/lib-esm/utils/testing.d.ts

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

@@ -1,3 +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;
+    [K in keyof O]: K extends string ? O[K] extends string ? `${K}` : `${K}.${KeyPaths<O[K]>}` : never;
 }[keyof O];

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

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

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

@@ -0,0 +1,6 @@
+// Inspired from reach-ui: https://github.com/reach/reach-ui/blob/develop/packages/utils/src/use-force-update.ts
+import React from 'react';
+export const useForceUpdate = () => {
+  const [, rerender] = React.useState({});
+  return React.useCallback(() => rerender({}), []);
+};

package/lib-esm/utils/useIsomorphicLayoutEffect.d.ts

@@ -0,0 +1,3 @@
+import { useEffect } from 'react';
+declare const useIsomorphicLayoutEffect: typeof useEffect;
+export default useIsomorphicLayoutEffect;

package/lib-esm/utils/useIsomorphicLayoutEffect.js

@@ -0,0 +1,3 @@
+import { useEffect, useLayoutEffect } from 'react';
+const useIsomorphicLayoutEffect = typeof window !== 'undefined' && typeof window.document !== 'undefined' && typeof window.document.createElement !== 'undefined' ? useLayoutEffect : useEffect;
+export default useIsomorphicLayoutEffect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/components",
-  "version": "31.2.0-rc.fbb10090",
+  "version": "31.2.0",
   "description": "Primer react components",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -15,12 +15,13 @@
     "start": "concurrently npm:start:*",
     "start:docs": "cd docs && npm run develop",
     "start:storybook": "start-storybook -p 6006",
-    "lint": "eslint '**/*.{js,ts,tsx,md,mdx}'",
+    "lint": "eslint '**/*.{js,ts,tsx,md,mdx}' --max-warnings=0",
     "lint:fix": "npm run lint -- --fix",
     "test": "jest",
     "test:update": "npm run test -- --updateSnapshot",
     "release": "npm run build && changeset publish",
-    "size": "size-limit"
+    "size": "size-limit",
+    "typecheck": "npx tsc --project tsconfig.json"
   },
   "repository": "primer/react",
   "keywords": [
@@ -43,8 +44,8 @@
   "author": "GitHub, Inc.",
   "license": "MIT",
   "dependencies": {
-    "@primer/octicons-react": "^13.0.0",
-    "@primer/primitives": "5.1.0",
+    "@primer/octicons-react": "^16.1.0",
+    "@primer/primitives": "6.1.0",
     "@radix-ui/react-polymorphic": "0.0.14",
     "@react-aria/ssr": "3.1.0",
     "@styled-system/css": "5.1.5",
@@ -124,6 +125,8 @@
     "lodash.isobject": "3.0.2",
     "prettier": "2.3.2",
     "react": "17.0.2",
+    "react-dnd": "14.0.4",
+    "react-dnd-html5-backend": "14.0.2",
     "react-dom": "17.0.2",
     "react-test-renderer": "17.0.2",
     "rollup": "2.56.3",
@@ -134,6 +137,7 @@
     "size-limit": "5.0.2",
     "storybook-addon-performance": "0.16.1",
     "styled-components": "4.4.1",
+    "ts-toolbelt": "9.6.0",
     "typescript": "4.2.2"
   },
   "peerDependencies": {

package/.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/master/docs/common-questions.md)

package/.changeset/config.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@1.4.0/schema.json",
-  "changelog": ["@changesets/changelog-github", {"repo": "primer/react"}],
-  "commit": false,
-  "linked": [],
-  "access": "public",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/.devcontainer/devcontainer.json

@@ -1,8 +0,0 @@
-{
-  "name": "Primer Components",
-  "image": "mcr.microsoft.com/vscode/devcontainers/typescript-node:14",
-  "extensions": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"],
-  "forwardPorts": [8000],
-  "postCreateCommand": ["/bin/bash", "-c", "pushd docs && npm install && popd && npm install"],
-  "remoteUser": "node"
-}

package/.eslintrc.json

@@ -1,137 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaFeatures": {
-      "jsx": true
-    }
-  },
-  "extends": [
-    "plugin:react/recommended",
-    "plugin:jsx-a11y/recommended",
-    "plugin:react-hooks/recommended",
-    "plugin:prettier/recommended",
-    "plugin:github/recommended",
-    "plugin:github/browser",
-    "plugin:primer-react/recommended"
-  ],
-  "ignorePatterns": [
-    "node_modules",
-    ".cache",
-    "coverage/**/*",
-    "docs/public/**/*",
-    "dist/**/*",
-    "lib/**/*",
-    "lib-*/**/*",
-    "types/**/*"
-  ],
-  "globals": {
-    "__DEV__": "readonly"
-  },
-  "env": {
-    "browser": true,
-    "commonjs": true,
-    "es6": true,
-    "jest": true,
-    "node": true
-  },
-  "settings": {
-    "react": {
-      "version": "detect"
-    }
-  },
-  // rules which apply to JS, TS, etc.
-  "rules": {
-    "react/prop-types": 0,
-    "react/display-name": 0,
-    "react-hooks/exhaustive-deps": "error",
-    "jsx-a11y/label-has-for": [
-      2,
-      {
-        "components": []
-      }
-    ],
-    "camelcase": [
-      "error",
-      {
-        "allow": ["dark_dimmed"]
-      }
-    ],
-    "primer-react/no-deprecated-colors": ["warn", {"checkAllStrings": true}]
-  },
-  "overrides": [
-    // rules which apply only to JS
-    {
-      "files": ["**/*.{js,jsx}"],
-      "rules": {
-        "eslint-comments/no-use": 0,
-        "import/no-namespace": 0,
-        "no-shadow": 0,
-        "no-unused-vars": [
-          "error",
-          {
-            "ignoreRestSiblings": true
-          }
-        ]
-      }
-    },
-    // rules which apply only to TS
-    {
-      "parserOptions": {
-        "project": "tsconfig.json"
-      },
-      "files": ["**/*.{ts,tsx}"],
-      "extends": ["plugin:@typescript-eslint/recommended"],
-      "rules": {
-        "@typescript-eslint/no-explicit-any": 2,
-        "@typescript-eslint/no-unnecessary-condition": 2,
-        "@typescript-eslint/explicit-module-boundary-types": 0,
-        "@typescript-eslint/no-unused-vars": [
-          "error",
-          {
-            "argsIgnorePattern": "^_"
-          }
-        ]
-      }
-    },
-    // rules which apply only to Markdown
-    {
-      "files": ["**/*.{md,mdx}"],
-      "extends": ["plugin:mdx/recommended"],
-      "settings": {
-        "mdx/code-blocks": true
-      },
-      "rules": {
-        "prettier/prettier": 0
-      }
-    },
-    // rules which apply only to Markdown code blocks
-    {
-      "files": ["**/*.{md,mdx}/**"],
-      "parserOptions": {
-        "project": false
-      },
-      "rules": {
-        "camelcase": 0,
-        "no-constant-condition": 0,
-        "no-console": 0,
-        "no-empty-pattern": 0,
-        "no-unused-vars": 0,
-        "no-undef": 0,
-        "react/no-unescaped-entities": 0,
-        "react/react-in-jsx-scope": 0,
-        "react/jsx-no-undef": 0,
-        "react/jsx-key": 0,
-        "react/jsx-no-comment-textnodes": 0,
-        "import/no-anonymous-default-export": 0,
-        "prettier/prettier": 0,
-        // These a11y rules should eventually be re-enabled
-        "jsx-a11y/anchor-is-valid": 0,
-        "jsx-a11y/accessible-emoji": 0,
-        "jsx-a11y/label-has-for": 0,
-        "@typescript-eslint/no-unnecessary-condition": 0,
-        "@typescript-eslint/no-unused-vars": 0,
-        "primer-react/no-deprecated-colors": ["error", {"skipImportCheck": true}]
-      }
-    }
-  ]
-}