@pingux/astro 1.1.1-alpha.1 → 1.1.1-alpha.2

package/lib/cjs/components/Modal/Modal.js

@@ -0,0 +1,218 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty2 = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty2(exports, "__esModule", {
+  value: true
+});
+
+exports["default"] = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/define-property"));
+
+var _defineProperties = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/define-properties"));
+
+var _getOwnPropertyDescriptors = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors"));
+
+var _forEach = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/for-each"));
+
+var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor"));
+
+var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/filter"));
+
+var _getOwnPropertySymbols = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols"));
+
+var _keys = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/keys"));
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _defineProperty3 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _overlays = require("@react-aria/overlays");
+
+var _dialog = require("@react-aria/dialog");
+
+var _focus = require("@react-aria/focus");
+
+var _CloseIcon = _interopRequireDefault(require("mdi-react/CloseIcon"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _IconButton = _interopRequireDefault(require("../IconButton"));
+
+var _Icon = _interopRequireDefault(require("../Icon"));
+
+var _Text = _interopRequireDefault(require("../Text"));
+
+var _hooks = require("../../hooks");
+
+var _react2 = require("@emotion/react");
+
+function ownKeys(object, enumerableOnly) { var keys = (0, _keys["default"])(object); if (_getOwnPropertySymbols["default"]) { var symbols = (0, _getOwnPropertySymbols["default"])(object); if (enumerableOnly) symbols = (0, _filter["default"])(symbols).call(symbols, function (sym) { return (0, _getOwnPropertyDescriptor["default"])(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { var _context; (0, _forEach["default"])(_context = ownKeys(Object(source), true)).call(_context, function (key) { (0, _defineProperty3["default"])(target, key, source[key]); }); } else if (_getOwnPropertyDescriptors["default"]) { (0, _defineProperties["default"])(target, (0, _getOwnPropertyDescriptors["default"])(source)); } else { var _context2; (0, _forEach["default"])(_context2 = ownKeys(Object(source))).call(_context2, function (key) { (0, _defineProperty2["default"])(target, key, (0, _getOwnPropertyDescriptor["default"])(source, key)); }); } } return target; }
+
+var Modal = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
+  var className = props.className,
+      closeButton = props.closeButton,
+      hasCloseButton = props.hasCloseButton,
+      id = props.id,
+      isClosedOnBlur = props.isClosedOnBlur,
+      isDismissable = props.isDismissable,
+      isKeyboardDismissDisabled = props.isKeyboardDismissDisabled,
+      isOpen = props.isOpen,
+      role = props.role,
+      title = props.title,
+      onClose = props.onClose,
+      shouldCloseOnInteractOutside = props.shouldCloseOnInteractOutside,
+      children = props.children,
+      propsContentProps = props.contentProps,
+      containerProps = props.containerProps,
+      others = (0, _objectWithoutProperties2["default"])(props, ["className", "closeButton", "hasCloseButton", "id", "isClosedOnBlur", "isDismissable", "isKeyboardDismissDisabled", "isOpen", "role", "title", "onClose", "shouldCloseOnInteractOutside", "children", "contentProps", "containerProps"]);
+
+  var contentProps = _objectSpread({
+    id: id,
+    shouldCloseOnBlur: isClosedOnBlur,
+    isDismissable: isDismissable,
+    isKeyboardDismissDisabled: isKeyboardDismissDisabled,
+    isOpen: isOpen,
+    role: role,
+    title: title,
+    onClose: onClose,
+    shouldCloseOnInteractOutside: shouldCloseOnInteractOutside,
+    children: children
+  }, propsContentProps);
+
+  var modalRef = (0, _react.useRef)();
+  /* istanbul ignore next */
+
+  (0, _react.useImperativeHandle)(ref, function () {
+    return modalRef.current;
+  }); // Handle interacting outside the dialog and pressing
+  // the Escape key to close the modal.
+
+  var _useOverlay = (0, _overlays.useOverlay)(contentProps, modalRef),
+      overlayProps = _useOverlay.overlayProps; // Prevent scrolling while the modal is open, and hide content
+  // outside the modal from screen readers.
+
+
+  (0, _overlays.usePreventScroll)();
+
+  var _useModal = (0, _overlays.useModal)(),
+      modalProps = _useModal.modalProps; // Get props for the dialog and its title
+
+
+  var _useDialog = (0, _dialog.useDialog)(contentProps, modalRef),
+      dialogProps = _useDialog.dialogProps,
+      titleProps = _useDialog.titleProps;
+
+  var _useStatusClasses = (0, _hooks.useStatusClasses)(className, {
+    isDarkMode: others.variant === 'modal.dark'
+  }),
+      classNames = _useStatusClasses.classNames;
+
+  return (0, _react2.jsx)(_overlays.OverlayContainer, null, (0, _react2.jsx)(_Box["default"], (0, _extends2["default"])({
+    className: classNames,
+    variant: "modal.container"
+  }, others, containerProps), (0, _react2.jsx)(_focus.FocusScope, {
+    contain: true,
+    restoreFocus: true,
+    autoFocus: true
+  }, (0, _react2.jsx)(_Box["default"], (0, _extends2["default"])({
+    variant: "modal.content"
+  }, propsContentProps, overlayProps, dialogProps, modalProps, {
+    ref: modalRef
+  }), hasCloseButton && (closeButton !== null && closeButton !== void 0 ? closeButton : (0, _react2.jsx)(_IconButton["default"], {
+    "aria-label": "Close modal window",
+    "data-id": "icon-button__close-modal-window",
+    size: 22,
+    variant: "modalCloseButton",
+    onPress: onClose
+  }, (0, _react2.jsx)(_Icon["default"], {
+    icon: _CloseIcon["default"]
+  }))), title && (0, _react2.jsx)(_react["default"].Fragment, null, (0, _react2.jsx)(_Text["default"], (0, _extends2["default"])({}, titleProps, {
+    variant: "variants.modal.title"
+  }), title)), children))));
+});
+Modal.propTypes = {
+  /** Used in tandem with `hasCloseButton` to customize how the close button is rendered. */
+  closeButton: _propTypes["default"].node,
+
+  /** The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). */
+  id: _propTypes["default"].string,
+
+  /** Whether the modal has a visible close button. */
+  hasCloseButton: _propTypes["default"].bool,
+
+  /** Whether the overlay should close when focus is lost or moves outside it. */
+  isClosedOnBlur: _propTypes["default"].bool,
+
+  /** Whether to close the overlay when the user interacts outside it. */
+  isDismissable: _propTypes["default"].bool,
+
+  /** Whether pressing the escape key to close the overlay should be disabled. */
+  isKeyboardDismissDisabled: _propTypes["default"].bool,
+
+  /** Whether the overlay is currently open. */
+  isOpen: _propTypes["default"].bool,
+
+  /** The accessibility role for the dialog. */
+  role: _propTypes["default"].oneOf(['dialog', 'alertdialog']),
+
+  /** The title for the modal. */
+  title: _propTypes["default"].node,
+
+  /**
+   * Handler that is called when the overlay should close.
+   *
+   * `() => void`
+   */
+  onClose: _propTypes["default"].func,
+
+  /**
+   * When a user interacts with the argument element outside of the overlay ref, return true if
+   * onClose should be called. This gives you a chance to filter out interaction with elements that
+   * should not dismiss the overlay. By default, onClose will always be called on interaction
+   * outside the overlay ref.
+   *
+   * `(element: HTMLElement) => boolean`
+   */
+  shouldCloseOnInteractOutside: _propTypes["default"].func,
+
+  /** Defines a string value that labels the current element. */
+  'aria-label': _propTypes["default"].string,
+
+  /** Identifies the element (or elements) that labels the current element. */
+  'aria-labelledby': _propTypes["default"].string,
+
+  /** Identifies the element (or elements) that describes the object. */
+  'aria-describedby': _propTypes["default"].string,
+
+  /**
+   * Identifies the element (or elements) that provide a detailed, extended description for the
+   * object.
+   */
+  'aria-details': _propTypes["default"].string,
+
+  /** Props object spread directly into the modal content Box. */
+  contentProps: _propTypes["default"].shape({}),
+
+  /** Props object spread directly into the modal container Box. */
+  containerProps: _propTypes["default"].shape({})
+};
+Modal.defaultProps = {
+  role: 'dialog'
+};
+Modal.displayName = 'Modal';
+var _default = Modal;
+exports["default"] = _default;

package/lib/cjs/components/Modal/Modal.stories.js

@@ -0,0 +1,173 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.DarkVariant = exports.Default = exports["default"] = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/slicedToArray"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _hooks = require("../../hooks");
+
+var _index = require("../../index");
+
+var _react2 = require("@emotion/react");
+
+var _default = {
+  title: 'Modal',
+  component: _index.Modal,
+  argTypes: {
+    title: {
+      control: {
+        type: 'text'
+      },
+      defaultValue: 'Delete Group'
+    },
+    role: {},
+    id: {
+      control: {
+        type: 'text'
+      }
+    },
+    hasCloseButton: {},
+    isClosedOnBlur: {},
+    isDismissable: {},
+    isKeyboardDismissDisabled: {},
+    'aria-label': {
+      control: {
+        type: 'text'
+      }
+    },
+    'aria-labelledby': {
+      control: {
+        type: 'text'
+      }
+    },
+    'aria-describedby': {
+      control: {
+        type: 'text'
+      }
+    },
+    'aria-details': {
+      control: {
+        type: 'text'
+      }
+    },
+    closeButton: {
+      control: {
+        type: 'none'
+      }
+    },
+    isOpen: {
+      control: {
+        type: 'none'
+      }
+    },
+    contentProps: {
+      control: {
+        type: 'none'
+      }
+    },
+    containerProps: {
+      control: {
+        type: 'none'
+      }
+    }
+  }
+};
+exports["default"] = _default;
+
+var Default = function Default(args) {
+  var state = (0, _hooks.useModalState)();
+
+  var _useState = (0, _react.useState)(''),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+      inputValue = _useState2[0],
+      setInputValue = _useState2[1];
+
+  var onTextFieldChange = (0, _react.useCallback)(function (_ref) {
+    var value = _ref.target.value;
+    setInputValue(value.toUpperCase());
+  }, []);
+  return (// Application must be wrapped in an OverlayProvider so that it can be hidden from screen
+    // readers when an overlay opens.
+    (0, _react2.jsx)(_index.OverlayProvider, null, (0, _react2.jsx)(_index.Button, {
+      onPress: state.open,
+      "aria-label": "Open modal"
+    }, "Open Modal"), state.isOpen && (0, _react2.jsx)(_index.Modal, (0, _extends2["default"])({}, args, {
+      isOpen: state.isOpen,
+      onClose: state.close
+    }), (0, _react2.jsx)(_index.Text, {
+      pt: "lg"
+    }, "Deleting a group ", (0, _react2.jsx)("strong", null, "\"Marketing\""), " cannot be undone. Users will lose access to the applications."), (0, _react2.jsx)(_index.Text, {
+      pt: "lg"
+    }, "Type the word DELETE to confirm deletion of this group"), (0, _react2.jsx)(_index.TextField, {
+      value: inputValue,
+      onChange: onTextFieldChange,
+      "aria-label": "user input"
+    }), (0, _react2.jsx)(_index.Box, {
+      isRow: true,
+      pt: "lg",
+      mr: "auto"
+    }, (0, _react2.jsx)(_index.Button, {
+      variant: "critical",
+      onPress: state.close,
+      mr: "md",
+      isDisabled: Boolean(inputValue !== 'DELETE'),
+      "aria-label": "Delete"
+    }, "Delete"), (0, _react2.jsx)(_index.Button, {
+      onPress: state.close,
+      "aria-label": "Cancel"
+    }, "Cancel"))))
+  );
+};
+
+exports.Default = Default;
+
+var DarkVariant = function DarkVariant() {
+  var state = (0, _hooks.useModalState)();
+  return (// Application must be wrapped in an OverlayProvider so that it can be hidden from screen
+    // readers when a modal opens.
+    (0, _react2.jsx)(_index.OverlayProvider, null, (0, _react2.jsx)(_index.Button, {
+      onPress: state.open,
+      "aria-label": "Open modal"
+    }, "Open Modal"), state.isOpen && (0, _react2.jsx)(_index.Modal, {
+      variant: "modal.dark",
+      title: "Question",
+      isOpen: state.isOpen,
+      onClose: state.close,
+      isDismissable: true,
+      hasCloseButton: true
+    }, (0, _react2.jsx)(_index.Text, {
+      variant: "subtitle",
+      color: "white",
+      pt: "lg"
+    }, "Would you ever really just click a button?"), (0, _react2.jsx)(_index.Box, {
+      isRow: true,
+      pt: "lg",
+      mr: "auto"
+    }, (0, _react2.jsx)(_index.Button, {
+      variant: "primary",
+      mr: "md",
+      onPress: state.close,
+      "aria-label": "Yes"
+    }, "Yes"), (0, _react2.jsx)(_index.Button, {
+      variant: "text",
+      onPress: state.close,
+      "aria-label": "Cancel"
+    }, "Cancel"))))
+  );
+};
+
+exports.DarkVariant = DarkVariant;

package/lib/cjs/components/Modal/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+_Object$defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _Modal["default"];
+  }
+});
+
+var _Modal = _interopRequireDefault(require("./Modal"));

package/lib/cjs/components/Modal/tests/Modal.integration.test.js

@@ -0,0 +1,95 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+
+var _testWrapper = require("../../../utils/testUtils/testWrapper");
+
+var _index = require("../../../index");
+
+var _hooks = require("../../../hooks");
+
+var _react2 = require("@emotion/react");
+
+// For testing the connection between the state hook, the trigger, and the modal itself
+
+/* eslint-disable react/prop-types */
+var ComposedComponent = function ComposedComponent(props) {
+  var defaultState = props.defaultState,
+      modalProps = props.modalProps;
+  var state = (0, _hooks.useModalState)(defaultState);
+  return (0, _react2.jsx)(_react["default"].Fragment, null, (0, _react2.jsx)(_index.Button, {
+    onPress: state.open
+  }), state.isOpen && (0, _react2.jsx)(_index.OverlayProvider, null, (0, _react2.jsx)(_index.Modal, (0, _extends2["default"])({
+    isOpen: state.isOpen,
+    onClose: state.close,
+    isDismissable: true,
+    hasCloseButton: true
+  }, modalProps))));
+};
+
+var getComposedComponent = function getComposedComponent(defaultState, modalProps) {
+  return (0, _testWrapper.render)((0, _react2.jsx)(ComposedComponent, {
+    defaultState: defaultState,
+    modalProps: modalProps
+  }));
+};
+
+test('clicking the trigger should open the modal', function () {
+  getComposedComponent();
+  expect(_testWrapper.screen.queryByRole('dialog')).not.toBeInTheDocument(); // Open it with the button trigger
+
+  _userEvent["default"].click(_testWrapper.screen.queryByRole('button'));
+
+  expect(_testWrapper.screen.queryByRole('dialog')).toBeInTheDocument();
+});
+test('keyboard interaction with the trigger should open the modal', function () {
+  getComposedComponent();
+
+  var button = _testWrapper.screen.queryByRole('button');
+
+  expect(_testWrapper.screen.queryByRole('dialog')).not.toBeInTheDocument(); // Open it with the button trigger
+
+  _testWrapper.fireEvent.keyDown(button, {
+    key: 'Enter',
+    code: 13
+  });
+
+  _testWrapper.fireEvent.keyUp(button, {
+    key: 'Enter',
+    code: 13
+  });
+
+  expect(_testWrapper.screen.queryByRole('dialog')).toBeInTheDocument();
+});
+test('close button should close the modal', function () {
+  getComposedComponent({
+    isDefaultOpen: true
+  }); // Target the close button
+
+  _userEvent["default"].click(_testWrapper.screen.queryAllByRole('button')[1]);
+
+  expect(_testWrapper.screen.queryByRole('dialog')).not.toBeInTheDocument();
+});
+test('keyboard interactions on the close button should close the modal', function () {
+  getComposedComponent({
+    isDefaultOpen: true
+  }); // Target the close button
+
+  _testWrapper.fireEvent.keyDown(_testWrapper.screen.queryAllByRole('button')[1], {
+    key: 'Enter',
+    code: 13
+  });
+
+  _testWrapper.fireEvent.keyUp(_testWrapper.screen.queryAllByRole('button')[1], {
+    key: 'Enter',
+    code: 13
+  });
+
+  expect(_testWrapper.screen.queryByRole('dialog')).not.toBeInTheDocument();
+});