@primer/components 0.0.0-202111613730 → 0.0.0-2021116163027

package/lib/ActionList2/{MenuContext.d.ts → ActionListContainerContext.d.ts}

@@ -1,10 +1,10 @@
 /** This context can be used by components that compose ActionList inside a Menu */
 import React from 'react';
 declare type ContextProps = {
-    parent?: string;
+    container?: string;
     listRole?: string;
     itemRole?: string;
-    afterSelect?: () => void;
+    afterSelect?: Function;
 };
-export declare const MenuContext: React.Context<ContextProps>;
+export declare const ActionListContainerContext: React.Context<ContextProps>;
 export {};

package/lib/ActionList2/{MenuContext.js → ActionListContainerContext.js}

@@ -3,13 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.MenuContext = void 0;
+exports.ActionListContainerContext = void 0;
 
 var _react = _interopRequireDefault(require("react"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /** This context can be used by components that compose ActionList inside a Menu */
-const MenuContext = /*#__PURE__*/_react.default.createContext({});
+const ActionListContainerContext = /*#__PURE__*/_react.default.createContext({});
 
-exports.MenuContext = MenuContext;
+exports.ActionListContainerContext = ActionListContainerContext;

package/lib/ActionList2/Item.js

@@ -21,7 +21,7 @@ var _createSlots = _interopRequireDefault(require("../utils/create-slots"));
 
 var _List = require("./List");
 
-var _MenuContext = require("./MenuContext");
+var _ActionListContainerContext = require("./ActionListContainerContext");
 
 var _Selection = require("./Selection");
 
@@ -96,7 +96,7 @@ const Item = /*#__PURE__*/_react.default.forwardRef(({
   const {
     itemRole,
     afterSelect
-  } = _react.default.useContext(_MenuContext.MenuContext);
+  } = _react.default.useContext(_ActionListContainerContext.ActionListContainerContext);
 
   const {
     theme
@@ -171,22 +171,20 @@ const Item = /*#__PURE__*/_react.default.forwardRef(({
   };
 
   const clickHandler = _react.default.useCallback(event => {
-    if (typeof onSelect !== 'function') return;
     if (disabled) return;
 
     if (!event.defaultPrevented) {
-      onSelect(event); // if this Item is inside a Menu, close the Menu
+      if (typeof onSelect === 'function') onSelect(event); // if this Item is inside a Menu, close the Menu
 
       if (typeof afterSelect === 'function') afterSelect();
     }
   }, [onSelect, disabled, afterSelect]);
 
   const keyPressHandler = _react.default.useCallback(event => {
-    if (typeof onSelect !== 'function') return;
     if (disabled) return;
 
     if (!event.defaultPrevented && [' ', 'Enter'].includes(event.key)) {
-      onSelect(event); // if this Item is inside a Menu, close the Menu
+      if (typeof onSelect === 'function') onSelect(event); // if this Item is inside a Menu, close the Menu
 
       if (typeof afterSelect === 'function') afterSelect();
     }

package/lib/ActionList2/List.js

@@ -11,7 +11,7 @@ var _styledComponents = _interopRequireDefault(require("styled-components"));
 
 var _sx = _interopRequireWildcard(require("../sx"));
 
-var _MenuContext = require("./MenuContext");
+var _ActionListContainerContext = require("./ActionListContainerContext");
 
 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); }
 
@@ -48,7 +48,7 @@ const List = /*#__PURE__*/_react.default.forwardRef(({
 
   const {
     listRole
-  } = _react.default.useContext(_MenuContext.MenuContext);
+  } = _react.default.useContext(_ActionListContainerContext.ActionListContainerContext);
 
   return /*#__PURE__*/_react.default.createElement(ListBox, _extends({
     sx: (0, _sx.merge)(styles, sxProp),

package/lib/ActionList2/Selection.js

@@ -13,7 +13,7 @@ var _List = require("./List");
 
 var _Group = require("./Group");
 
-var _MenuContext = require("./MenuContext");
+var _ActionListContainerContext = require("./ActionListContainerContext");
 
 var _Visuals = require("./Visuals");
 
@@ -31,8 +31,8 @@ const Selection = ({
   } = _react.default.useContext(_Group.GroupContext);
 
   const {
-    parent
-  } = _react.default.useContext(_MenuContext.MenuContext);
+    container
+  } = _react.default.useContext(_ActionListContainerContext.ActionListContainerContext);
   /** selectionVariant in Group can override the selectionVariant in List root */
 
 
@@ -44,7 +44,7 @@ const Selection = ({
     return null;
   }
 
-  if (parent === 'ActionMenu') {
+  if (container === 'ActionMenu') {
     throw new Error('ActionList cannot have a selectionVariant inside ActionMenu, please use DropdownMenu or SelectPanel instead. More information: https://primer.style/design/components/action-list#application');
     return null;
   }

package/lib/ActionMenu2.d.ts

@@ -1,10 +1,12 @@
 import { ButtonProps } from './Button';
 import React from 'react';
+import { AnchoredOverlayProps } from './AnchoredOverlay';
 import { OverlayProps } from './Overlay';
-import { AnchoredOverlayWrapperAnchorProps } from './AnchoredOverlay/AnchoredOverlay';
-declare type ActionMenuBaseProps = {
+declare type MenuContextProps = Pick<AnchoredOverlayProps, 'anchorRef' | 'renderAnchor' | 'open' | 'onOpen' | 'onClose'>;
+export declare const MenuContext: React.Context<MenuContextProps>;
+export declare type ActionMenuProps = {
     /**
-     * Recommended: `ActionMenu.Button` or `ActionMenu.Anchor` with ActionList`
+     * Recommended: `ActionMenu.Button` or `ActionMenu.Anchor` with `ActionMenu.Overlay`
      */
     children: React.ReactElement[] | React.ReactElement;
     /**
@@ -15,17 +17,18 @@ declare type ActionMenuBaseProps = {
      * If defined, will control the open/closed state of the overlay. Must be used in conjuction with `open`.
      */
     onOpenChange?: (s: boolean) => void;
-    /**
-     * Props to be spread on the internal `Overlay` component.
-     */
-    overlayProps?: Partial<OverlayProps>;
-};
-export declare type ActionMenuProps = ActionMenuBaseProps & AnchoredOverlayWrapperAnchorProps;
+} & Pick<AnchoredOverlayProps, 'anchorRef'>;
 export declare type MenuAnchorProps = {
     children: React.ReactElement;
 };
 /** this component is syntactical sugar 🍭 */
 export declare type MenuButtonProps = ButtonProps;
+declare type MenuOverlayProps = Partial<OverlayProps> & {
+    /**
+     * Recommended: `ActionList`
+     */
+    children: React.ReactElement[] | React.ReactElement;
+};
 export declare const ActionMenu: React.FC<ActionMenuProps> & {
     Button: React.ForwardRefExoticComponent<Pick<{
         color?: string | undefined;
@@ -308,6 +311,7 @@ export declare const ActionMenu: React.FC<ActionMenuProps> & {
         variant?: "small" | "medium" | "large" | undefined;
     }> & React.RefAttributes<React.RefObject<HTMLElement> | undefined>>;
     Anchor: React.ForwardRefExoticComponent<MenuAnchorProps & React.RefAttributes<React.RefObject<HTMLElement> | undefined>>;
+    Overlay: React.FC<MenuOverlayProps>;
     Divider: React.FC<import("./sx").SxProp>;
 };
 export {};

package/lib/ActionMenu2.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ActionMenu = void 0;
+exports.ActionMenu = exports.MenuContext = void 0;
 
 var _Button = _interopRequireDefault(require("./Button"));
 
@@ -11,59 +11,60 @@ var _react = _interopRequireDefault(require("react"));
 
 var _AnchoredOverlay = require("./AnchoredOverlay");
 
-var _useProvidedStateOrCreate = require("./hooks/useProvidedStateOrCreate");
-
 var _hooks = require("./hooks");
 
 var _Divider = require("./ActionList2/Divider");
 
-var _MenuContext = require("./ActionList2/MenuContext");
+var _ActionListContainerContext = require("./ActionList2/ActionListContainerContext");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const ActionMenuBase = ({
+const MenuContext = /*#__PURE__*/_react.default.createContext({
+  renderAnchor: null,
+  open: false
+});
+
+exports.MenuContext = MenuContext;
+
+const Menu = ({
   anchorRef: externalAnchorRef,
   open,
   onOpenChange,
-  overlayProps,
   children
 }) => {
-  const [combinedOpenState, setCombinedOpenState] = (0, _useProvidedStateOrCreate.useProvidedStateOrCreate)(open, onOpenChange, false);
-  const anchorRef = (0, _hooks.useProvidedRefOrCreate)(externalAnchorRef);
+  const [combinedOpenState, setCombinedOpenState] = (0, _hooks.useProvidedStateOrCreate)(open, onOpenChange, false);
 
   const onOpen = _react.default.useCallback(() => setCombinedOpenState(true), [setCombinedOpenState]);
 
   const onClose = _react.default.useCallback(() => setCombinedOpenState(false), [setCombinedOpenState]);
 
-  let renderAnchor = null;
-  const contents = [];
+  const anchorRef = (0, _hooks.useProvidedRefOrCreate)(externalAnchorRef);
+  let renderAnchor = null; // 🚨 Hack for good API!
+  // we strip out Anchor from children and pass it to AnchoredOverlay to render
+  // with additional props for accessibility
 
-  _react.default.Children.map(children, child => {
+  const contents = _react.default.Children.map(children, child => {
     if (child.type === MenuButton || child.type === Anchor) {
       renderAnchor = anchorProps => /*#__PURE__*/_react.default.cloneElement(child, anchorProps);
-    } else {
-      contents.push(child);
+
+      return null;
     }
+
+    return child;
   });
 
-  return /*#__PURE__*/_react.default.createElement(_AnchoredOverlay.AnchoredOverlay, {
-    renderAnchor: renderAnchor,
-    anchorRef: anchorRef,
-    open: combinedOpenState,
-    onOpen: onOpen,
-    onClose: onClose,
-    overlayProps: overlayProps
-  }, /*#__PURE__*/_react.default.createElement(_MenuContext.MenuContext.Provider, {
+  return /*#__PURE__*/_react.default.createElement(MenuContext.Provider, {
     value: {
-      parent: 'ActionMenu',
-      listRole: 'menu',
-      itemRole: 'menuitem',
-      afterSelect: onClose
+      anchorRef,
+      renderAnchor,
+      open: combinedOpenState,
+      onOpen,
+      onClose
     }
-  }, contents));
+  }, contents);
 };
 
-ActionMenuBase.displayName = "ActionMenuBase";
+Menu.displayName = "Menu";
 
 const Anchor = /*#__PURE__*/_react.default.forwardRef(({
   children,
@@ -82,10 +83,43 @@ const MenuButton = /*#__PURE__*/_react.default.forwardRef((props, anchorRef) =>
   }, /*#__PURE__*/_react.default.createElement(_Button.default, props));
 });
 
-ActionMenuBase.displayName = 'ActionMenu';
-const ActionMenu = Object.assign(ActionMenuBase, {
+const Overlay = ({
+  children,
+  ...overlayProps
+}) => {
+  // we typecast anchorRef as required instead of optional
+  // because we know that we're setting it in context in Menu
+  const {
+    anchorRef,
+    renderAnchor,
+    open,
+    onOpen,
+    onClose
+  } = _react.default.useContext(MenuContext);
+
+  return /*#__PURE__*/_react.default.createElement(_AnchoredOverlay.AnchoredOverlay, {
+    anchorRef: anchorRef,
+    renderAnchor: renderAnchor,
+    open: open,
+    onOpen: onOpen,
+    onClose: onClose,
+    overlayProps: overlayProps
+  }, /*#__PURE__*/_react.default.createElement(_ActionListContainerContext.ActionListContainerContext.Provider, {
+    value: {
+      container: 'ActionMenu',
+      listRole: 'menu',
+      itemRole: 'menuitem',
+      afterSelect: onClose
+    }
+  }, children));
+};
+
+Overlay.displayName = "Overlay";
+Menu.displayName = 'ActionMenu';
+const ActionMenu = Object.assign(Menu, {
   Button: MenuButton,
   Anchor,
+  Overlay,
   Divider: _Divider.Divider
 });
 exports.ActionMenu = ActionMenu;

package/lib/Autocomplete/AutocompleteMenu.js

@@ -21,6 +21,10 @@ var _uniqueId = require("../utils/uniqueId");
 
 var _scrollIntoViewingArea = require("../behaviors/scrollIntoViewingArea");
 
+var _VisuallyHidden = _interopRequireDefault(require("../_VisuallyHidden"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 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); }
 
 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; }
@@ -182,19 +186,8 @@ function AutocompleteMenu(props) {
       setSelectedItemLength(selectedItemIds.length);
     }
   }, [selectedItemIds, setSelectedItemLength]);
-  return /*#__PURE__*/_react.default.createElement(_.Box, {
-    sx: !showMenu ? {
-      // visually hides this label for sighted users
-      position: 'absolute',
-      width: '1px',
-      height: '1px',
-      padding: '0',
-      margin: '-1px',
-      overflow: 'hidden',
-      clip: 'rect(0, 0, 0, 0)',
-      whiteSpace: 'nowrap',
-      borderWidth: '0'
-    } : {}
+  return /*#__PURE__*/_react.default.createElement(_VisuallyHidden.default, {
+    isVisible: showMenu
   }, loading ? /*#__PURE__*/_react.default.createElement(_.Box, {
     p: 3,
     display: "flex",

package/lib/CheckboxInputField.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+declare const _default: React.FC<import("./_InputField/ToggleInputField").Props> & {
+    Input: React.FC<Omit<React.HTMLProps<HTMLInputElement>, "ref"> & {
+        ref?: React.Ref<HTMLInputElement> | undefined;
+    }>;
+    Caption: React.FC<{}>;
+    Label: React.FC<import("./_InputField/InputFieldLabel").Props>;
+    LeadingVisual: React.FC<{}>;
+};
+export default _default;

package/lib/CheckboxInputField.js

@@ -0,0 +1,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _ = require(".");
+
+var _InputField = _interopRequireDefault(require("./_InputField/InputField"));
+
+var _slots = require("./_InputField/slots");
+
+var _ToggleInputField = _interopRequireDefault(require("./_InputField/ToggleInputField"));
+
+var _ToggleInputLeadingVisual = _interopRequireDefault(require("./_InputField/ToggleInputLeadingVisual"));
+
+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 Input = ({
+  id: idProp,
+  required: requiredProp,
+  disabled: disabledProp,
+  ...rest
+}) => {
+  if (idProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'id' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  if (disabledProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'disabled' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  if (requiredProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'required' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  return /*#__PURE__*/_react.default.createElement(_slots.Slot, {
+    name: "Input"
+  }, ({
+    disabled,
+    id,
+    required,
+    captionId
+  }) => /*#__PURE__*/_react.default.createElement(_.Checkbox, _extends({
+    "aria-describedby": captionId,
+    id: id,
+    required: required,
+    disabled: disabled
+  }, rest)));
+};
+
+Input.displayName = "Input";
+
+const CheckboxInputField = props => /*#__PURE__*/_react.default.createElement(_ToggleInputField.default, props);
+
+CheckboxInputField.displayName = "CheckboxInputField";
+
+var _default = Object.assign(CheckboxInputField, {
+  Input,
+  Caption: _InputField.default.Caption,
+  Label: _InputField.default.Label,
+  LeadingVisual: _ToggleInputLeadingVisual.default
+});
+
+exports.default = _default;

package/lib/RadioInputField.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+declare const _default: React.FC<import("./_InputField/ToggleInputField").Props> & {
+    Input: React.FC<React.HTMLProps<HTMLInputElement>>;
+    Caption: React.FC<{}>;
+    Label: React.FC<import("./_InputField/InputFieldLabel").Props>;
+    LeadingVisual: React.FC<{}>;
+};
+export default _default;

package/lib/RadioInputField.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _InputField = _interopRequireDefault(require("./_InputField/InputField"));
+
+var _slots = require("./_InputField/slots");
+
+var _ToggleInputField = _interopRequireDefault(require("./_InputField/ToggleInputField"));
+
+var _ToggleInputLeadingVisual = _interopRequireDefault(require("./_InputField/ToggleInputLeadingVisual"));
+
+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); }
+
+// TODO: use Primer's checkbox input once it's available
+// https://github.com/github/primer/issues/489
+const RadioInput = props => {
+  return /*#__PURE__*/_react.default.createElement("input", _extends({
+    type: "radio"
+  }, props));
+};
+
+RadioInput.displayName = "RadioInput";
+
+// pulling out `id`, `disabled`, and `required` because those should come from the parent TextInputField component
+const Input = ({
+  id: idProp,
+  required: requiredProp,
+  disabled: disabledProp,
+  ...rest
+}) => {
+  if (idProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'id' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  if (disabledProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'disabled' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  if (requiredProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'required' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  return /*#__PURE__*/_react.default.createElement(_slots.Slot, {
+    name: "Input"
+  }, ({
+    disabled,
+    id,
+    required,
+    captionId
+  }) => /*#__PURE__*/_react.default.createElement(RadioInput, _extends({
+    "aria-describedby": captionId,
+    id: id,
+    required: required,
+    disabled: disabled
+  }, rest)));
+};
+
+Input.displayName = "Input";
+
+const RadioInputField = props => /*#__PURE__*/_react.default.createElement(_ToggleInputField.default, props);
+
+RadioInputField.displayName = "RadioInputField";
+
+var _default = Object.assign(RadioInputField, {
+  Input,
+  Caption: _InputField.default.Caption,
+  Label: _InputField.default.Label,
+  LeadingVisual: _ToggleInputLeadingVisual.default
+});
+
+exports.default = _default;