@primer/components 31.2.0-rc.5ccefd7d → 31.2.0-rc.b718ff50

package/docs/src/@primer/gatsby-theme-doctocat/components/hero.js

@@ -9,9 +9,7 @@ export default function Hero() {
     <ThemeProvider colorMode="night" nightScheme="dark_dimmed">
       <Box bg="canvas.default" py={6}>
         <Container>
-          <Heading color="accent.fg" fontSize={7} lineHeight="condensed" pb={3} m={0}>
-            Primer React
-          </Heading>
+          <Heading sx={{color: 'accent.fg', fontSize: 7, lineHeight: 'condensed', pb: 3, m: 0}}>Primer React</Heading>
           <Text as="p" fontFamily="mono" mt={0} mb={2} color="fg.default" fontSize={2}>
             v{version}
           </Text>

package/docs/src/@primer/gatsby-theme-doctocat/components/live-preview-wrapper.js

@@ -8,7 +8,7 @@ function ThemeSwitcher() {
   return (
     <DropdownMenu
       renderAnchor={({children, ...anchorProps}) => (
-        <DropdownButton variant="small" {...anchorProps}>
+        <DropdownButton {...anchorProps} sx={{variant: 'small'}}>
           {children}
         </DropdownButton>
       )}

package/lib/Overlay.js

@@ -11,6 +11,8 @@ var _react = _interopRequireWildcard(require("react"));
 
 var _constants = require("./constants");
 
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("./utils/useIsomorphicLayoutEffect"));
+
 var _hooks = require("./hooks");
 
 var _Portal = _interopRequireDefault(require("./Portal"));
@@ -139,7 +141,7 @@ const Overlay = /*#__PURE__*/_react.default.forwardRef(({
       combinedRef.current.style.height = `${combinedRef.current.clientHeight}px`;
     }
   }, [height, combinedRef]);
-  (0, _react.useLayoutEffect)(() => {
+  (0, _useIsomorphicLayoutEffect.default)(() => {
     var _overlayRef$current;
 
     const {

package/lib/Portal/Portal.js

@@ -10,6 +10,8 @@ var _react = _interopRequireDefault(require("react"));
 
 var _reactDom = require("react-dom");
 
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("../utils/useIsomorphicLayoutEffect"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const PRIMER_PORTAL_ROOT_ID = '__primerPortalRoot__';
@@ -72,7 +74,7 @@ const Portal = ({
 
   const elementRef = _react.default.useRef(hostElement);
 
-  _react.default.useLayoutEffect(() => {
+  (0, _useIsomorphicLayoutEffect.default)(() => {
     let containerName = _containerName;
 
     if (containerName === undefined) {
@@ -93,7 +95,6 @@ const Portal = ({
       parentElement.removeChild(element);
     }; // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [elementRef]);
-
   return /*#__PURE__*/(0, _reactDom.createPortal)(children, elementRef.current);
 };
 

package/lib/__tests__/AnchoredOverlay.test.js

@@ -152,9 +152,11 @@ describe('AnchoredOverlay', () => {
     expect(mockCloseCallback).toHaveBeenCalledWith('escape');
   });
   it('should render consistently when open', () => {
-    const anchoredOverlay = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
+    const {
+      container
+    } = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
       initiallyOpen: true
     }));
-    expect(anchoredOverlay).toMatchSnapshot();
+    expect(container).toMatchSnapshot();
   });
 });

package/lib/__tests__/TextInputWithTokens.test.js

@@ -58,16 +58,7 @@ const LabelledTextInputWithTokens = ({
   tokens: tokens,
   onTokenRemove: onTokenRemove,
   id: "tokenInput"
-}, rest))); // describe('axe test', () => {
-//   it('should have no axe violations', async () => {
-//     const onRemoveMock = jest.fn()
-//     const {container} = HTMLRender(<LabelledTextInputWithTokens tokens={mockTokens} onTokenRemove={onRemoveMock} />)
-//     const results = await axe(container)
-//     expect(results).toHaveNoViolations()
-//     cleanup()
-//   })
-// })
-
+}, rest)));
 
 jest.useFakeTimers();
 describe('TextInputWithTokens', () => {

package/lib/hooks/useAnchoredPosition.js

@@ -13,6 +13,8 @@ var _useProvidedRefOrCreate = require("./useProvidedRefOrCreate");
 
 var _useResizeObserver = require("./useResizeObserver");
 
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("../utils/useIsomorphicLayoutEffect"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -39,8 +41,7 @@ function useAnchoredPosition(settings, dependencies = []) {
   }, // eslint-disable-next-line react-hooks/exhaustive-deps
   [floatingElementRef, anchorElementRef, ...dependencies]);
 
-  _react.default.useLayoutEffect(updatePosition, [updatePosition]);
-
+  (0, _useIsomorphicLayoutEffect.default)(updatePosition, [updatePosition]);
   (0, _useResizeObserver.useResizeObserver)(updatePosition);
   return {
     floatingElementRef,

package/lib/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/hooks/useCombinedRefs.js

@@ -5,11 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.useCombinedRefs = useCombinedRefs;
 
-var _react = _interopRequireWildcard(require("react"));
+var _react = require("react");
 
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("../utils/useIsomorphicLayoutEffect"));
 
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
  * Creates a ref by combining multiple constituent refs. The ref returned by this hook
@@ -21,8 +21,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  */
 function useCombinedRefs(...refs) {
   const combinedRef = (0, _react.useRef)(null);
-
-  _react.default.useLayoutEffect(() => {
+  (0, _useIsomorphicLayoutEffect.default)(() => {
     function setRefs(current = null) {
       for (const ref of refs) {
         if (!ref) {
@@ -44,6 +43,5 @@ function useCombinedRefs(...refs) {
       setRefs(combinedRef.current);
     }; // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [...refs, combinedRef.current]);
-
   return combinedRef;
 }

package/lib/hooks/useResizeObserver.js

@@ -5,12 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.useResizeObserver = useResizeObserver;
 
-var _react = _interopRequireDefault(require("react"));
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("../utils/useIsomorphicLayoutEffect"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function useResizeObserver(callback) {
-  _react.default.useLayoutEffect(() => {
+  (0, _useIsomorphicLayoutEffect.default)(() => {
     const observer = new window.ResizeObserver(() => callback());
     observer.observe(document.documentElement);
     return () => {

package/lib/stories/Token.stories.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WithOnRemoveFn = exports.Interactive = exports.DefaultToken = exports.default = void 0;
+exports.WithOnRemoveFn = exports.WithLeadingVisual = exports.Interactive = exports.DefaultToken = exports.default = void 0;
 
 var _react = _interopRequireDefault(require("react"));
 
@@ -19,6 +19,8 @@ var _Token = _interopRequireDefault(require("../Token/Token"));
 
 var _Text = _interopRequireDefault(require("../Text"));
 
+var _octiconsReact = require("@primer/octicons-react");
+
 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); }
@@ -36,7 +38,7 @@ var _default = {
   }]
 };
 exports.default = _default;
-const excludedControlKeys = ['id', 'as', 'tabIndex', 'onRemove'];
+const excludedControlKeys = ['id', 'as', 'tabIndex', 'onRemove', 'leadingVisual'];
 
 const SingleExampleContainer = ({
   children,
@@ -115,6 +117,21 @@ Interactive.parameters = {
   }
 };
 
+const WithLeadingVisual = args => {
+  return /*#__PURE__*/_react.default.createElement(ExampleCollectionContainer, null, /*#__PURE__*/_react.default.createElement(_Token.default, _extends({}, args, {
+    leadingVisual: () => /*#__PURE__*/_react.default.createElement(_octiconsReact.GitBranchIcon, null)
+  })));
+};
+
+exports.WithLeadingVisual = WithLeadingVisual;
+WithLeadingVisual.displayName = "WithLeadingVisual";
+WithLeadingVisual.storyName = 'with leadingVisual';
+WithLeadingVisual.parameters = {
+  controls: {
+    exclude: [...excludedControlKeys, 'hideRemoveButton']
+  }
+};
+
 const WithOnRemoveFn = args => {
   return /*#__PURE__*/_react.default.createElement(ExampleCollectionContainer, null, /*#__PURE__*/_react.default.createElement(SingleExampleContainer, {
     label: "w/ onRemove passed"

package/lib/utils/useIsomorphicLayoutEffect.d.ts

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

package/lib/utils/useIsomorphicLayoutEffect.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = require("react");
+
+const useIsomorphicLayoutEffect = typeof window !== 'undefined' && typeof window.document !== 'undefined' && typeof window.document.createElement !== 'undefined' ? _react.useLayoutEffect : _react.useEffect;
+var _default = useIsomorphicLayoutEffect;
+exports.default = _default;

package/lib-esm/Overlay.js

@@ -1,8 +1,9 @@
 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 styled from 'styled-components';
-import React, { useEffect, useLayoutEffect, useRef } from 'react';
+import React, { useEffect, useRef } from 'react';
 import { get, COMMON } from './constants';
+import useLayoutEffect from './utils/useIsomorphicLayoutEffect';
 import { useOverlay } from './hooks';
 import Portal from './Portal';
 import sx from './sx';

package/lib-esm/Portal/Portal.js

@@ -1,5 +1,6 @@
 import React from 'react';
 import { createPortal } from 'react-dom';
+import useLayoutEffect from '../utils/useIsomorphicLayoutEffect';
 const PRIMER_PORTAL_ROOT_ID = '__primerPortalRoot__';
 const DEFAULT_PORTAL_CONTAINER_NAME = '__default__';
 const portalRootRegistry = {};
@@ -57,7 +58,7 @@ export const Portal = ({
   hostElement.style.position = 'relative';
   hostElement.style.zIndex = '1';
   const elementRef = React.useRef(hostElement);
-  React.useLayoutEffect(() => {
+  useLayoutEffect(() => {
     let containerName = _containerName;
 
     if (containerName === undefined) {

package/lib-esm/__tests__/AnchoredOverlay.test.js

@@ -126,9 +126,11 @@ describe('AnchoredOverlay', () => {
     expect(mockCloseCallback).toHaveBeenCalledWith('escape');
   });
   it('should render consistently when open', () => {
-    const anchoredOverlay = HTMLRender( /*#__PURE__*/React.createElement(AnchoredOverlayTestComponent, {
+    const {
+      container
+    } = HTMLRender( /*#__PURE__*/React.createElement(AnchoredOverlayTestComponent, {
       initiallyOpen: true
     }));
-    expect(anchoredOverlay).toMatchSnapshot();
+    expect(container).toMatchSnapshot();
   });
 });

package/lib-esm/__tests__/TextInputWithTokens.test.js

@@ -46,16 +46,7 @@ const LabelledTextInputWithTokens = ({
   tokens: tokens,
   onTokenRemove: onTokenRemove,
   id: "tokenInput"
-}, rest))); // describe('axe test', () => {
-//   it('should have no axe violations', async () => {
-//     const onRemoveMock = jest.fn()
-//     const {container} = HTMLRender(<LabelledTextInputWithTokens tokens={mockTokens} onTokenRemove={onRemoveMock} />)
-//     const results = await axe(container)
-//     expect(results).toHaveNoViolations()
-//     cleanup()
-//   })
-// })
-
+}, rest)));
 
 jest.useFakeTimers();
 describe('TextInputWithTokens', () => {

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/stories/Token.stories.js

@@ -7,6 +7,7 @@ import { BaseStyles, ThemeProvider } from '..';
 import Box from '../Box';
 import Token from '../Token/Token';
 import Text from '../Text';
+import { GitBranchIcon } from '@primer/octicons-react';
 export default {
   title: 'Tokens/Default',
   component: Token,
@@ -19,7 +20,7 @@ export default {
     return /*#__PURE__*/React.createElement(ThemeProvider, null, /*#__PURE__*/React.createElement(BaseStyles, null, /*#__PURE__*/React.createElement(Story, null)));
   }]
 };
-const excludedControlKeys = ['id', 'as', 'tabIndex', 'onRemove'];
+const excludedControlKeys = ['id', 'as', 'tabIndex', 'onRemove', 'leadingVisual'];
 
 const SingleExampleContainer = ({
   children,
@@ -91,6 +92,18 @@ Interactive.parameters = {
     exclude: [...excludedControlKeys, 'hideRemoveButton', 'text']
   }
 };
+export const WithLeadingVisual = args => {
+  return /*#__PURE__*/React.createElement(ExampleCollectionContainer, null, /*#__PURE__*/React.createElement(Token, _extends({}, args, {
+    leadingVisual: () => /*#__PURE__*/React.createElement(GitBranchIcon, null)
+  })));
+};
+WithLeadingVisual.displayName = "WithLeadingVisual";
+WithLeadingVisual.storyName = 'with leadingVisual';
+WithLeadingVisual.parameters = {
+  controls: {
+    exclude: [...excludedControlKeys, 'hideRemoveButton']
+  }
+};
 export const WithOnRemoveFn = args => {
   return /*#__PURE__*/React.createElement(ExampleCollectionContainer, null, /*#__PURE__*/React.createElement(SingleExampleContainer, {
     label: "w/ onRemove passed"

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/migrating.md

@@ -110,7 +110,7 @@ There are two ways to change the theme of @primer/components components:
 
    export default () => (
      <ThemeProvider theme={theme}>
-       <Block color="bodytext" p={4}>
+       <Block sx={{color: 'bodytext', p: 4}}>
          <Text fontSize={4}>Hello, world!</Text>
        </Block>
      </ThemeProvider>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/components",
-  "version": "31.2.0-rc.5ccefd7d",
+  "version": "31.2.0-rc.b718ff50",
   "description": "Primer react components",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -15,7 +15,7 @@
     "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",

package/script/build

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -e
+
 # Clean up
 rm -rf dist
 rm -rf lib

package/src/Overlay.tsx

@@ -1,7 +1,8 @@
 import styled from 'styled-components'
-import React, {ReactElement, useEffect, useLayoutEffect, useRef} from 'react'
+import React, {ReactElement, useEffect, useRef} from 'react'
 import {get, COMMON, SystemPositionProps, SystemCommonProps} from './constants'
 import {ComponentProps} from './utils/types'
+import useLayoutEffect from './utils/useIsomorphicLayoutEffect'
 import {useOverlay, TouchOrMouseEvent} from './hooks'
 import Portal from './Portal'
 import sx, {SxProp} from './sx'

package/src/Portal/Portal.tsx

@@ -1,5 +1,6 @@
 import React from 'react'
 import {createPortal} from 'react-dom'
+import useLayoutEffect from '../utils/useIsomorphicLayoutEffect'
 
 const PRIMER_PORTAL_ROOT_ID = '__primerPortalRoot__'
 const DEFAULT_PORTAL_CONTAINER_NAME = '__default__'
@@ -69,7 +70,7 @@ export const Portal: React.FC<PortalProps> = ({children, onMount, containerName:
   hostElement.style.zIndex = '1'
   const elementRef = React.useRef(hostElement)
 
-  React.useLayoutEffect(() => {
+  useLayoutEffect(() => {
     let containerName = _containerName
     if (containerName === undefined) {
       containerName = DEFAULT_PORTAL_CONTAINER_NAME

package/src/__tests__/AnchoredOverlay.test.tsx

@@ -144,7 +144,7 @@ describe('AnchoredOverlay', () => {
   })
 
   it('should render consistently when open', () => {
-    const anchoredOverlay = HTMLRender(<AnchoredOverlayTestComponent initiallyOpen={true} />)
-    expect(anchoredOverlay).toMatchSnapshot()
+    const {container} = HTMLRender(<AnchoredOverlayTestComponent initiallyOpen={true} />)
+    expect(container).toMatchSnapshot()
   })
 })

package/src/__tests__/TextInputWithTokens.test.tsx

@@ -29,16 +29,6 @@ const LabelledTextInputWithTokens: React.FC<TextInputWithTokensProps> = ({onToke
   </>
 )
 
-// describe('axe test', () => {
-//   it('should have no axe violations', async () => {
-//     const onRemoveMock = jest.fn()
-//     const {container} = HTMLRender(<LabelledTextInputWithTokens tokens={mockTokens} onTokenRemove={onRemoveMock} />)
-//     const results = await axe(container)
-//     expect(results).toHaveNoViolations()
-//     cleanup()
-//   })
-// })
-
 jest.useFakeTimers()
 
 describe('TextInputWithTokens', () => {