@primer/components 0.0.0-2021111171525 → 0.0.0-20211111716

package/lib/NewButton/button.js

@@ -0,0 +1,308 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Button = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+
+var _sx = _interopRequireWildcard(require("../sx"));
+
+var _ThemeProvider = require("../ThemeProvider");
+
+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; }
+
+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 TEXT_ROW_HEIGHT = '20px'; // custom value off the scale
+
+const getVariantStyles = (variant = 'default', theme) => {
+  const style = {
+    default: {
+      color: 'btn.text',
+      backgroundColor: 'btn.bg',
+      boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.shadow}, ${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.insetShadow}`,
+      '&:hover:not([disabled])': {
+        backgroundColor: 'btn.hoverBg'
+      },
+      // focus must come before :active so that the active box shadow overrides
+      '&:focus:not([disabled])': {
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.focusShadow}`
+      },
+      '&:active:not([disabled])': {
+        backgroundColor: 'btn.selectedBg',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.shadowActive}`
+      },
+      '&:disabled': {
+        color: 'primer.fg.disabled',
+        backgroundColor: 'btn.disabledBg'
+      }
+    },
+    primary: {
+      color: 'btn.primary.text',
+      backgroundColor: 'btn.primary.bg',
+      borderColor: 'border.subtle',
+      boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.primary.shadow}`,
+      '&:hover:not([disabled])': {
+        color: 'btn.primary.hoverText',
+        backgroundColor: 'btn.primary.hoverBg'
+      },
+      // focus must come before :active so that the active box shadow overrides
+      '&:focus:not([disabled])': {
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.primary.focusShadow}`
+      },
+      '&:active:not([disabled])': {
+        backgroundColor: 'btn.primary.selectedBg',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.primary.selectedShadow}`
+      },
+      '&:disabled': {
+        color: 'btn.primary.disabledText',
+        backgroundColor: 'btn.primary.disabledBg'
+      },
+      '[data-component="ButtonCounter"]': {
+        backgroundColor: 'btn.primary.counterBg',
+        color: 'btn.primary.text'
+      }
+    },
+    danger: {
+      color: 'btn.danger.text',
+      backgroundColor: 'btn.bg',
+      boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.shadow}`,
+      '&:hover:not([disabled])': {
+        color: 'btn.danger.hoverText',
+        backgroundColor: 'btn.danger.hoverBg',
+        borderColor: 'btn.danger.hoverBorder',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.danger.hoverShadow}`,
+        '[data-component="ButtonCounter"]': {
+          backgroundColor: 'btn.danger.hoverCounterBg',
+          color: 'btn.danger.hoverText'
+        }
+      },
+      // focus must come before :active so that the active box shadow overrides
+      '&:focus:not([disabled])': {
+        borderColor: 'btn.danger.focusBorder',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.danger.focusShadow}`
+      },
+      '&:active:not([disabled])': {
+        color: 'btn.danger.selectedText',
+        backgroundColor: 'btn.danger.selectedBg',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.danger.selectedShadow}`,
+        borderColor: 'btn.danger.selectedBorder'
+      },
+      '&:disabled': {
+        color: 'btn.danger.disabledText',
+        backgroundColor: 'btn.danger.disabledBg',
+        borderColor: 'btn.danger.disabledBorder',
+        '[data-component="ButtonCounter"]': {
+          backgroundColor: 'btn.danger.disabledCounterBg'
+        }
+      },
+      '[data-component="ButtonCounter"]': {
+        color: 'btn.danger.text',
+        backgroundColor: 'btn.danger.counterBg'
+      }
+    },
+    invisible: {
+      color: 'accent.fg',
+      backgroundColor: 'transparent',
+      border: '0',
+      boxShadow: 'none',
+      '&:hover:not([disabled])': {
+        backgroundColor: 'btn.hoverBg'
+      },
+      // focus must come before :active so that the active box shadow overrides
+      '&:focus:not([disabled])': {
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.focusShadow}`
+      },
+      '&:active:not([disabled])': {
+        backgroundColor: 'btn.selectedBg'
+      },
+      '&:disabled': {
+        color: 'primer.fg.disabled'
+      }
+    },
+    outline: {
+      color: 'btn.outline.text',
+      boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.shadow}`,
+      '&:hover': {
+        color: 'btn.outline.hoverText',
+        backgroundColor: 'btn.outline.hoverBg',
+        borderColor: 'outline.hoverBorder',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.outline.hoverShadow}`,
+        '[data-component="ButtonCounter"]': {
+          backgroundColor: 'btn.outline.hoverCounterBg',
+          color: 'btn.outline.hoverText'
+        }
+      },
+      // focus must come before :active so that the active box shadow overrides
+      '&:focus': {
+        borderColor: 'btn.outline.focusBorder',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.outline.focusShadow}`
+      },
+      '&:active:not([disabled])': {
+        color: 'btn.outline.selectedText',
+        backgroundColor: 'btn.outline.selectedBg',
+        boxShadow: `${theme === null || theme === void 0 ? void 0 : theme.shadows.btn.outline.selectedShadow}`,
+        borderColor: 'btn.outline.selectedBorder'
+      },
+      '&:disabled': {
+        color: 'btn.outline.disabledText',
+        backgroundColor: 'btn.outline.disabledBg',
+        borderColor: 'btn.border',
+        '[data-component="ButtonCounter"]': {
+          backgroundColor: 'btn.outline.disabledCounterBg'
+        }
+      },
+      '[data-component="ButtonCounter"]': {
+        backgroundColor: 'btn.outline.counterBg',
+        color: 'btn.outline.text'
+      }
+    }
+  };
+  return style[variant];
+};
+
+const getSizeStyles = (size = 'medium', variant = 'default', iconOnly) => {
+  let paddingY, paddingX, fontSize;
+
+  switch (size) {
+    case 'small':
+      paddingY = 3;
+      paddingX = 12;
+      fontSize = 0;
+      break;
+
+    case 'large':
+      paddingY = 9;
+      paddingX = 20;
+      fontSize = 2;
+      break;
+
+    case 'medium':
+    default:
+      paddingY = 5;
+      paddingX = 16;
+      fontSize = 1;
+  }
+
+  if (iconOnly) {
+    paddingX = paddingY + 2;
+  }
+
+  if (variant === 'invisible') {
+    paddingY = paddingY + 1;
+  }
+
+  return {
+    paddingY: `${paddingY}px`,
+    paddingX: `${paddingX}px`,
+    fontSize,
+    '[data-component="ButtonCounter"]': {
+      fontSize
+    }
+  };
+};
+
+const ButtonBase = _styledComponents.default.button.withConfig({
+  displayName: "button__ButtonBase",
+  componentId: "sc-15k5iqk-0"
+})(_sx.default);
+
+const Button = /*#__PURE__*/(0, _react.forwardRef)(({
+  children,
+  sx: sxProp = {},
+  ...props
+}, forwardedRef) => {
+  const {
+    icon: Icon,
+    leadingIcon: LeadingIcon,
+    trailingIcon: TrailingIcon,
+    variant = 'default',
+    size = 'medium'
+  } = props;
+  const iconOnly = !!Icon;
+  const {
+    theme
+  } = (0, _ThemeProvider.useTheme)();
+  const styles = {
+    borderRadius: '2',
+    border: '1px solid',
+    borderColor: theme === null || theme === void 0 ? void 0 : theme.colors.btn.border,
+    display: 'grid',
+    gridTemplateAreas: '"leadingIcon text trailingIcon"',
+    fontWeight: 'bold',
+    lineHeight: TEXT_ROW_HEIGHT,
+    whiteSpace: 'nowrap',
+    verticalAlign: 'middle',
+    cursor: 'pointer',
+    appearance: 'none',
+    userSelect: 'none',
+    textDecoration: 'none',
+    textAlign: 'center',
+    '& > :not(:last-child)': {
+      mr: '2'
+    },
+    '&:focus': {
+      outline: 'none'
+    },
+    '&:disabled': {
+      cursor: 'default'
+    },
+    '&:disabled svg': {
+      opacity: '0.6'
+    },
+    '[data-component="leadingIcon"]': {
+      gridArea: 'leadingIcon'
+    },
+    '[data-component="text"]': {
+      gridArea: 'text'
+    },
+    '[data-component="trailingIcon"]': {
+      gridArea: 'trailingIcon'
+    }
+  };
+  const iconWrapStyles = {
+    display: 'inline-block'
+  };
+
+  const sxStyles = _sx.merge.all([styles, getSizeStyles(size, variant, iconOnly), getVariantStyles(variant, theme), sxProp]);
+
+  return /*#__PURE__*/_react.default.createElement(ButtonBase, _extends({
+    sx: sxStyles,
+    ref: forwardedRef
+  }, props), LeadingIcon && /*#__PURE__*/_react.default.createElement(_Box.default, {
+    as: "span",
+    "data-component": "leadingIcon",
+    sx: iconWrapStyles,
+    "aria-hidden": !iconOnly
+  }, /*#__PURE__*/_react.default.createElement(LeadingIcon, null)), /*#__PURE__*/_react.default.createElement("span", {
+    "data-component": "text",
+    hidden: Icon ? true : false
+  }, children), Icon && /*#__PURE__*/_react.default.createElement(_Box.default, {
+    "data-component": "icon-only",
+    as: "span",
+    sx: {
+      display: 'inline-block'
+    },
+    "aria-hidden": !iconOnly
+  }, /*#__PURE__*/_react.default.createElement(Icon, null)), TrailingIcon && /*#__PURE__*/_react.default.createElement(_Box.default, {
+    as: "span",
+    "data-component": "trailingIcon",
+    sx: { ...iconWrapStyles,
+      ml: 2
+    },
+    "aria-hidden": !iconOnly
+  }, /*#__PURE__*/_react.default.createElement(TrailingIcon, null)));
+});
+exports.Button = Button;
+Button.displayName = 'Button';
+Object.assign(Button, {});

package/lib/NewButton/index.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { ButtonProps } from './types';
+export type { ButtonProps as NewButtonProps };
+export declare const NewButton: import("react").ForwardRefExoticComponent<{
+    variant?: import("./types").VariantType | undefined;
+    size?: import("./types").Size | undefined;
+    icon?: import("react").FunctionComponent<import("@primer/octicons-react/dist/icons").IconProps> | undefined;
+    leadingIcon?: import("react").FunctionComponent<import("@primer/octicons-react/dist/icons").IconProps> | undefined;
+    trailingIcon?: import("react").FunctionComponent<import("@primer/octicons-react/dist/icons").IconProps> | undefined;
+    disabled?: boolean | undefined;
+    children: import("react").ReactNode;
+} & import("../sx").SxProp & import("react").HTMLAttributes<HTMLButtonElement> & import("react").RefAttributes<HTMLButtonElement>> & {
+    Counter: ({ children, sx: sxProp, ...props }: import("./button-counter").CounterProps) => JSX.Element;
+};

package/lib/NewButton/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NewButton = void 0;
+
+var _button = require("./button");
+
+var _buttonCounter = require("./button-counter");
+
+const NewButton = Object.assign(_button.Button, {
+  Counter: _buttonCounter.Counter
+});
+exports.NewButton = NewButton;

package/lib/NewButton/types.d.ts

@@ -0,0 +1,32 @@
+import React, { HTMLAttributes } from 'react';
+import { IconProps } from '@primer/octicons-react';
+import { SxProp } from '../sx';
+export declare type VariantType = 'default' | 'primary' | 'invisible' | 'danger' | 'outline';
+export declare type Size = 'small' | 'medium' | 'large';
+export declare type ButtonProps = {
+    /**
+     * Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'
+     */
+    variant?: VariantType;
+    /**
+     * Size of button and fontSize of text in button
+     */
+    size?: Size;
+    /**
+     * This is to be used if it is an icon-only button. Will make text visually hidden
+     */
+    icon?: React.FunctionComponent<IconProps>;
+    /**
+     * The leading icon comes before button content
+     */
+    leadingIcon?: React.FunctionComponent<IconProps>;
+    /**
+     * The trailing icon comes after button content
+     */
+    trailingIcon?: React.FunctionComponent<IconProps>;
+    /**
+     * Items that are disabled can not be clicked, selected, or navigated through.
+     */
+    disabled?: boolean;
+    children: React.ReactNode;
+} & SxProp & HTMLAttributes<HTMLButtonElement>;

package/lib/Overlay.d.ts

@@ -0,0 +1,66 @@
+import React, { ComponentPropsWithRef } from 'react';
+import { AriaRole, Merge } from './utils/types';
+import { TouchOrMouseEvent } from './hooks';
+import { SxProp } from './sx';
+import { AnchorSide } from './behaviors/anchoredPosition';
+import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
+declare type StyledOverlayProps = {
+    width?: keyof typeof widthMap;
+    height?: keyof typeof heightMap;
+    maxHeight?: keyof Omit<typeof heightMap, 'auto' | 'initial'>;
+    visibility?: 'visible' | 'hidden';
+    anchorSide?: AnchorSide;
+} & SxProp;
+declare const heightMap: {
+    xsmall: string;
+    small: string;
+    medium: string;
+    large: string;
+    xlarge: string;
+    auto: string;
+    initial: string;
+};
+declare const widthMap: {
+    small: string;
+    medium: string;
+    large: string;
+    xlarge: string;
+    xxlarge: string;
+    auto: string;
+};
+declare type BaseOverlayProps = {
+    ignoreClickRefs?: React.RefObject<HTMLElement>[];
+    initialFocusRef?: React.RefObject<HTMLElement>;
+    returnFocusRef: React.RefObject<HTMLElement>;
+    onClickOutside: (e: TouchOrMouseEvent) => void;
+    onEscape: (e: KeyboardEvent) => void;
+    visibility?: 'visible' | 'hidden';
+    'data-test-id'?: unknown;
+    top?: number;
+    left?: number;
+    portalContainerName?: string;
+    preventFocusOnOpen?: boolean;
+    role?: AriaRole;
+    children?: React.ReactNode;
+};
+declare type OwnOverlayProps = Merge<StyledOverlayProps, BaseOverlayProps>;
+/**
+ * An `Overlay` is a flexible floating surface, used to display transient content such as menus,
+ * selection options, dialogs, and more. Overlays use shadows to express elevation. The `Overlay`
+ * component handles all behaviors needed by overlay UIs as well as the common styles that all overlays * should have.
+ * @param ignoreClickRefs Optional. An array of ref objects to ignore clicks on in the `onOutsideClick` behavior. This is often used to ignore clicking on the element that toggles the open/closed state for the `Overlay` to prevent the `Overlay` from being toggled twice.
+ * @param initialFocusRef Optional. Ref for the element to focus when the `Overlay` is opened. If nothing is provided, the first focusable element in the `Overlay` body is focused.
+ * @param returnFocusRef Required. Ref for the element to focus when the `Overlay` is closed.
+ * @param onClickOutside  Required. Function to call when clicking outside of the `Overlay`. Typically this function removes the Overlay.
+ * @param onEscape Required. Function to call when user presses `Escape`. Typically this function removes the Overlay.
+ * @param width Sets the width of the `Overlay`, pick from our set list of widths, or pass `auto` to automatically set the width based on the content of the `Overlay`. `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `480px`, `xlarge` corresponds to `640px`, `xxlarge` corresponds to `960px`.
+ * @param height Sets the height of the `Overlay`, pick from our set list of heights, or pass `auto` to automatically set the height based on the content of the `Overlay`, or pass `initial` to set the height based on the initial content of the `Overlay` (i.e. ignoring content changes). `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`.
+ * @param maxHeight Sets the maximum height of the `Overlay`, pick from our set list of heights. `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`.
+ * @param anchorSide If provided, the Overlay will slide into position from the side of the anchor with a brief animation
+ * @param top Optional. Vertical position of the overlay, relative to its closest positioned ancestor (often its `Portal`).
+ * @param left Optional. Horizontal position of the overlay, relative to its closest positioned ancestor (often its `Portal`).
+ * @param portalContainerName Optional. The name of the portal container to render the Overlay into.
+ */
+declare const Overlay: PolymorphicForwardRefComponent<"div", OwnOverlayProps>;
+export declare type OverlayProps = ComponentPropsWithRef<typeof Overlay>;
+export default Overlay;

package/lib/Overlay.js

@@ -0,0 +1,184 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("./utils/useIsomorphicLayoutEffect"));
+
+var _constants = require("./constants");
+
+var _hooks = require("./hooks");
+
+var _Portal = _interopRequireDefault(require("./Portal"));
+
+var _sx = _interopRequireDefault(require("./sx"));
+
+var _useCombinedRefs = require("./hooks/useCombinedRefs");
+
+var _ThemeProvider = require("./ThemeProvider");
+
+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; }
+
+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 heightMap = {
+  xsmall: '192px',
+  small: '256px',
+  medium: '320px',
+  large: '432px',
+  xlarge: '600px',
+  auto: 'auto',
+  initial: 'auto' // Passing 'initial' initially applies 'auto'
+
+};
+const widthMap = {
+  small: '256px',
+  medium: '320px',
+  large: '480px',
+  xlarge: '640px',
+  xxlarge: '960px',
+  auto: 'auto'
+};
+const animationDuration = 200;
+
+function getSlideAnimationStartingVector(anchorSide) {
+  if (anchorSide !== null && anchorSide !== void 0 && anchorSide.endsWith('bottom')) {
+    return {
+      x: 0,
+      y: -1
+    };
+  } else if (anchorSide !== null && anchorSide !== void 0 && anchorSide.endsWith('top')) {
+    return {
+      x: 0,
+      y: 1
+    };
+  } else if (anchorSide !== null && anchorSide !== void 0 && anchorSide.endsWith('right')) {
+    return {
+      x: -1,
+      y: 0
+    };
+  } else if (anchorSide !== null && anchorSide !== void 0 && anchorSide.endsWith('left')) {
+    return {
+      x: 1,
+      y: 0
+    };
+  }
+
+  return {
+    x: 0,
+    y: 0
+  };
+}
+
+const StyledOverlay = _styledComponents.default.div.withConfig({
+  displayName: "Overlay__StyledOverlay",
+  componentId: "jhwkzw-0"
+})(["background-color:", ";box-shadow:", ";position:absolute;min-width:192px;max-width:640px;height:", ";max-height:", ";width:", ";border-radius:12px;overflow:hidden;animation:overlay-appear ", "ms ", ";@keyframes overlay-appear{0%{opacity:0;}100%{opacity:1;}}visibility:var(--styled-overlay-visibility);:focus{outline:none;}", ";"], (0, _constants.get)('colors.canvas.overlay'), (0, _constants.get)('shadows.overlay.shadow'), props => heightMap[props.height || 'auto'], props => props.maxHeight && heightMap[props.maxHeight], props => widthMap[props.width || 'auto'], animationDuration, (0, _constants.get)('animation.easeOutCubic'), _sx.default);
+
+/**
+ * An `Overlay` is a flexible floating surface, used to display transient content such as menus,
+ * selection options, dialogs, and more. Overlays use shadows to express elevation. The `Overlay`
+ * component handles all behaviors needed by overlay UIs as well as the common styles that all overlays * should have.
+ * @param ignoreClickRefs Optional. An array of ref objects to ignore clicks on in the `onOutsideClick` behavior. This is often used to ignore clicking on the element that toggles the open/closed state for the `Overlay` to prevent the `Overlay` from being toggled twice.
+ * @param initialFocusRef Optional. Ref for the element to focus when the `Overlay` is opened. If nothing is provided, the first focusable element in the `Overlay` body is focused.
+ * @param returnFocusRef Required. Ref for the element to focus when the `Overlay` is closed.
+ * @param onClickOutside  Required. Function to call when clicking outside of the `Overlay`. Typically this function removes the Overlay.
+ * @param onEscape Required. Function to call when user presses `Escape`. Typically this function removes the Overlay.
+ * @param width Sets the width of the `Overlay`, pick from our set list of widths, or pass `auto` to automatically set the width based on the content of the `Overlay`. `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `480px`, `xlarge` corresponds to `640px`, `xxlarge` corresponds to `960px`.
+ * @param height Sets the height of the `Overlay`, pick from our set list of heights, or pass `auto` to automatically set the height based on the content of the `Overlay`, or pass `initial` to set the height based on the initial content of the `Overlay` (i.e. ignoring content changes). `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`.
+ * @param maxHeight Sets the maximum height of the `Overlay`, pick from our set list of heights. `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`.
+ * @param anchorSide If provided, the Overlay will slide into position from the side of the anchor with a brief animation
+ * @param top Optional. Vertical position of the overlay, relative to its closest positioned ancestor (often its `Portal`).
+ * @param left Optional. Horizontal position of the overlay, relative to its closest positioned ancestor (often its `Portal`).
+ * @param portalContainerName Optional. The name of the portal container to render the Overlay into.
+ */
+const Overlay = /*#__PURE__*/_react.default.forwardRef(({
+  onClickOutside,
+  role = 'none',
+  initialFocusRef,
+  returnFocusRef,
+  ignoreClickRefs,
+  onEscape,
+  visibility = 'visible',
+  height,
+  top,
+  left,
+  anchorSide,
+  portalContainerName,
+  preventFocusOnOpen,
+  ...rest
+}, forwardedRef) => {
+  const overlayRef = (0, _react.useRef)(null);
+  const combinedRef = (0, _useCombinedRefs.useCombinedRefs)(overlayRef, forwardedRef);
+  const {
+    theme
+  } = (0, _ThemeProvider.useTheme)();
+  const slideAnimationDistance = parseInt((0, _constants.get)('space.2')(theme).replace('px', ''));
+  const slideAnimationEasing = (0, _constants.get)('animation.easeOutCubic')(theme);
+  (0, _hooks.useOverlay)({
+    overlayRef,
+    returnFocusRef,
+    onEscape,
+    ignoreClickRefs,
+    onClickOutside,
+    initialFocusRef,
+    preventFocusOnOpen
+  });
+  (0, _react.useEffect)(() => {
+    var _combinedRef$current;
+
+    if (height === 'initial' && (_combinedRef$current = combinedRef.current) !== null && _combinedRef$current !== void 0 && _combinedRef$current.clientHeight) {
+      combinedRef.current.style.height = `${combinedRef.current.clientHeight}px`;
+    }
+  }, [height, combinedRef]);
+  (0, _useIsomorphicLayoutEffect.default)(() => {
+    var _overlayRef$current;
+
+    const {
+      x,
+      y
+    } = getSlideAnimationStartingVector(anchorSide);
+
+    if (!x && !y || !((_overlayRef$current = overlayRef.current) !== null && _overlayRef$current !== void 0 && _overlayRef$current.animate) || visibility === 'hidden') {
+      return;
+    } // JS animation is required because Safari does not allow css animations to start paused and then run
+
+
+    overlayRef.current.animate({
+      transform: [`translate(${slideAnimationDistance * x}px, ${slideAnimationDistance * y}px)`, `translate(0, 0)`]
+    }, {
+      duration: animationDuration,
+      easing: slideAnimationEasing
+    });
+  }, [anchorSide, slideAnimationDistance, slideAnimationEasing, visibility]);
+  return /*#__PURE__*/_react.default.createElement(_Portal.default, {
+    containerName: portalContainerName
+  }, /*#__PURE__*/_react.default.createElement(StyledOverlay, _extends({
+    height: height,
+    role: role
+  }, rest, {
+    ref: combinedRef,
+    style: {
+      top: `${top || 0}px`,
+      left: `${left || 0}px`,
+      '--styled-overlay-visibility': visibility
+    }
+  })));
+});
+
+Overlay.defaultProps = {
+  height: 'auto',
+  width: 'auto'
+};
+var _default = Overlay;
+exports.default = _default;

package/lib/Pagehead.d.ts

@@ -0,0 +1,5 @@
+import { SxProp } from './sx';
+import { ComponentProps } from './utils/types';
+declare const Pagehead: import("styled-components").StyledComponent<"div", any, SxProp, never>;
+export declare type PageheadProps = ComponentProps<typeof Pagehead>;
+export default Pagehead;

package/lib/Pagehead.js

@@ -5,30 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _styledComponents = _interopRequireDefault(require("styled-components"));
 
 var _constants = require("./constants");
 
 var _sx = _interopRequireDefault(require("./sx"));
 
-var _theme = _interopRequireDefault(require("./theme"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const Pagehead = _styledComponents.default.div.withConfig({
   displayName: "Pagehead",
   componentId: "sc-1ntn78e-0"
-})(["position:relative;padding-top:", ";padding-bottom:", ";margin-bottom:", ";border-bottom:1px solid ", ";", ";", ";"], (0, _constants.get)('space.4'), (0, _constants.get)('space.4'), (0, _constants.get)('space.4'), (0, _constants.get)('colors.border.gray'), _constants.COMMON, _sx.default);
+})(["position:relative;padding-top:", ";padding-bottom:", ";margin-bottom:", ";border-bottom:1px solid ", ";", ";"], (0, _constants.get)('space.4'), (0, _constants.get)('space.4'), (0, _constants.get)('space.4'), (0, _constants.get)('colors.border.default'), _sx.default);
 
-Pagehead.defaultProps = {
-  theme: _theme.default
-};
-Pagehead.propTypes = {
-  children: _propTypes.default.node,
-  ..._constants.COMMON.propTypes,
-  ..._sx.default.propTypes
-};
 var _default = Pagehead;
 exports.default = _default;