@pingux/astro 1.27.0-alpha.24 → 1.27.0-alpha.26

package/lib/components/Modal/Modal.js

@@ -0,0 +1,196 @@
+import _Object$defineProperty from "@babel/runtime-corejs3/core-js-stable/object/define-property";
+import _Object$defineProperties from "@babel/runtime-corejs3/core-js-stable/object/define-properties";
+import _Object$getOwnPropertyDescriptors from "@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors";
+import _forEachInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/for-each";
+import _Object$getOwnPropertyDescriptor from "@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor";
+import _filterInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/filter";
+import _Object$getOwnPropertySymbols from "@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols";
+import _Object$keys from "@babel/runtime-corejs3/core-js-stable/object/keys";
+import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
+import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
+import _objectWithoutProperties from "@babel/runtime-corejs3/helpers/esm/objectWithoutProperties";
+var _excluded = ["className", "closeButton", "hasAutoFocus", "hasCloseButton", "id", "isClosedOnBlur", "isDismissable", "isKeyboardDismissDisabled", "isOpen", "role", "title", "onClose", "shouldCloseOnInteractOutside", "children", "contentProps", "containerProps"];
+
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(source), !0)).call(_context, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import React, { forwardRef, useRef, useImperativeHandle } from 'react';
+import PropTypes from 'prop-types';
+import { useOverlay, usePreventScroll, useModal, OverlayContainer } from '@react-aria/overlays';
+import { useDialog } from '@react-aria/dialog';
+import { FocusScope } from '@react-aria/focus';
+import CloseIcon from 'mdi-react/CloseIcon';
+import Box from '../Box';
+import IconButton from '../IconButton';
+import Icon from '../Icon';
+import Text from '../Text';
+import { useStatusClasses, useDeprecationWarning } from '../../hooks';
+/**
+  * Modals are overlays that interrupt a user’s workflow to convey an important message.
+  * The component must be wrapped in an OverlayProvider, and the first child should be a trigger,
+  * such as Button.
+*/
+
+import { jsx as ___EmotionJSX } from "@emotion/react";
+var Modal = /*#__PURE__*/forwardRef(function (props, ref) {
+  var className = props.className,
+      closeButton = props.closeButton,
+      hasAutoFocus = props.hasAutoFocus,
+      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 = _objectWithoutProperties(props, _excluded);
+
+  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 = useRef();
+  /* istanbul ignore next */
+
+  useImperativeHandle(ref, function () {
+    return modalRef.current;
+  }); // Handle interacting outside the dialog and pressing
+  // the Escape key to close the modal.
+
+  var _useOverlay = useOverlay(contentProps, modalRef),
+      overlayProps = _useOverlay.overlayProps; // Prevent scrolling while the modal is open, and hide content
+  // outside the modal from screen readers.
+
+
+  usePreventScroll();
+
+  var _useModal = useModal(),
+      modalProps = _useModal.modalProps; // Get props for the dialog and its title
+
+
+  var _useDialog = useDialog(contentProps, modalRef),
+      dialogProps = _useDialog.dialogProps,
+      titleProps = _useDialog.titleProps;
+
+  var _useStatusClasses = useStatusClasses(className, {
+    isDarkMode: others.variant === 'modal.dark'
+  }),
+      classNames = _useStatusClasses.classNames;
+
+  useDeprecationWarning('The "dark" variant for Modal will be deprecated in Astro-UI 2.0.0.', {
+    isActive: others.variant === 'modal.dark'
+  });
+  return ___EmotionJSX(OverlayContainer, null, ___EmotionJSX(Box, _extends({
+    className: classNames,
+    variant: "modal.container"
+  }, others, containerProps), ___EmotionJSX(FocusScope, {
+    contain: true,
+    restoreFocus: true,
+    autoFocus: hasAutoFocus
+  }, ___EmotionJSX(Box, _extends({
+    variant: "modal.content"
+  }, propsContentProps, overlayProps, dialogProps, modalProps, {
+    ref: modalRef,
+    "aria-modal": true
+  }), hasCloseButton && (closeButton !== null && closeButton !== void 0 ? closeButton : ___EmotionJSX(IconButton, {
+    "aria-label": "Close modal window",
+    "data-id": "icon-button__close-modal-window",
+    size: 22,
+    variant: "modalCloseButton",
+    onPress: onClose
+  }, ___EmotionJSX(Icon, {
+    icon: CloseIcon
+  }))), title && ___EmotionJSX(React.Fragment, null, ___EmotionJSX(Text, _extends({}, titleProps, {
+    variant: "variants.modal.title"
+  }), title)), children))));
+});
+Modal.propTypes = {
+  /** Used in tandem with `hasCloseButton` to customize how the close button is rendered. */
+  closeButton: PropTypes.node,
+
+  /** The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). */
+  id: PropTypes.string,
+
+  /** Whether to auto focus the first focusable element in the focus scope on mount. */
+  hasAutoFocus: PropTypes.bool,
+
+  /** Whether the modal has a visible close button. */
+  hasCloseButton: PropTypes.bool,
+
+  /** Whether the overlay should close when focus is lost or moves outside it. */
+  isClosedOnBlur: PropTypes.bool,
+
+  /** Whether to close the overlay when the user interacts outside it. */
+  isDismissable: PropTypes.bool,
+
+  /** Whether pressing the escape key to close the overlay should be disabled. */
+  isKeyboardDismissDisabled: PropTypes.bool,
+
+  /** Whether the overlay is currently open. */
+  isOpen: PropTypes.bool,
+
+  /** The accessibility role for the dialog. */
+  role: PropTypes.oneOf(['dialog', 'alertdialog']),
+
+  /** The title for the modal. */
+  title: PropTypes.node,
+
+  /**
+   * Handler that is called when the overlay should close.
+   *
+   * `() => void`
+   */
+  onClose: PropTypes.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.func,
+
+  /** Defines a string value that labels the current element. */
+  'aria-label': PropTypes.string,
+
+  /** Identifies the element (or elements) that labels the current element. */
+  'aria-labelledby': PropTypes.string,
+
+  /** Identifies the element (or elements) that describes the object. */
+  'aria-describedby': PropTypes.string,
+
+  /**
+   * Identifies the element (or elements) that provide a detailed, extended description for the
+   * object.
+   */
+  'aria-details': PropTypes.string,
+
+  /** Props object spread directly into the modal content Box. */
+  contentProps: PropTypes.shape({}),
+
+  /** Props object spread directly into the modal container Box. */
+  containerProps: PropTypes.shape({})
+};
+Modal.defaultProps = {
+  role: 'dialog'
+};
+Modal.displayName = 'Modal';
+export default Modal;

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

@@ -0,0 +1,97 @@
+import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
+import React from 'react';
+import { useModalState } from '../../hooks';
+import { OverlayProvider, Box, Button, Text, Modal } from '../../index';
+import { jsx as ___EmotionJSX } from "@emotion/react";
+export default {
+  title: 'Modal',
+  component: Modal,
+  argTypes: {
+    title: {
+      control: {
+        type: 'text'
+      },
+      defaultValue: 'Continue'
+    },
+    role: {},
+    id: {
+      control: {
+        type: 'text'
+      }
+    },
+    hasCloseButton: {
+      defaultValue: true
+    },
+    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'
+      }
+    }
+  }
+};
+export var Default = function Default(args) {
+  var state = useModalState();
+  return (// Application must be wrapped in an OverlayProvider so that it can be hidden from screen
+    // readers when an overlay opens.
+    ___EmotionJSX(OverlayProvider, null, ___EmotionJSX(Button, {
+      onPress: state.open,
+      "aria-label": "Open modal"
+    }, "Open Modal"), state.isOpen && ___EmotionJSX(Modal, _extends({}, args, {
+      isOpen: state.isOpen,
+      onClose: state.close
+    }), ___EmotionJSX(Text, {
+      pt: "lg"
+    }, "Do you want to continue with this action that you\u2018re performing?"), ___EmotionJSX(Box, {
+      isRow: true,
+      pt: "lg",
+      mr: "auto"
+    }, ___EmotionJSX(Button, {
+      variant: "primary",
+      onPress: state.close,
+      mr: "md",
+      "aria-label": "Continue"
+    }, "Continue"), ___EmotionJSX(Button, {
+      variant: "link",
+      onPress: state.close,
+      "aria-label": "Cancel"
+    }, "Cancel"))))
+  );
+};

package/lib/components/Modal/index.js

@@ -0,0 +1 @@
+export { default } from './Modal';

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

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

package/lib/components/Modal/tests/Modal.unit.test.js

@@ -0,0 +1,188 @@
+import React from 'react';
+import userEvent from '@testing-library/user-event';
+import axeTest from '../../../utils/testUtils/testAxe';
+import { render, screen, queryByAttribute } from '../../../utils/testUtils/testWrapper';
+import { OverlayProvider, Modal } from '../../../index'; // For testing the modal alone
+
+import { jsx as ___EmotionJSX } from "@emotion/react";
+
+var getComponent = function getComponent() {
+  var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return render(___EmotionJSX(OverlayProvider, null, ___EmotionJSX(Modal, props)));
+}; // **********
+// Unit tests
+// **********
+// Need to be added to each test file to test accessibility using axe.
+
+
+axeTest(getComponent);
+test('default modal', function () {
+  getComponent();
+  expect(screen.queryByRole('dialog')).toBeInTheDocument();
+  expect(screen.queryByRole('dialog')).toHaveAttribute('aria-modal', 'true'); // Close button not rendered by default
+
+  expect(screen.queryByRole('button')).not.toBeInTheDocument();
+});
+test('should spread undocumented props to the container element', function () {
+  getComponent({
+    'data-prop': 'test'
+  });
+  var container = queryByAttribute('data-prop', document, 'test');
+  var modal = screen.getByRole('dialog');
+  expect(container).toContainElement(modal);
+  expect(modal).not.toHaveAttribute('data-prop', 'test');
+});
+test('should spread container props to the container element even if documented', function () {
+  getComponent({
+    containerProps: {
+      id: 'test'
+    }
+  });
+  var container = queryByAttribute('id', document, 'test');
+  var modal = screen.getByRole('dialog');
+  expect(container).toContainElement(modal);
+  expect(modal).not.toHaveAttribute('id', 'test');
+});
+test('should spread content props to the modal dialog even if undocumented', function () {
+  getComponent({
+    contentProps: {
+      'data-prop': 'test'
+    }
+  });
+  var modal = screen.getByRole('dialog');
+  expect(modal).toHaveAttribute('data-prop', 'test');
+});
+test('should display title for modal', function () {
+  var title = 'my title';
+  getComponent({
+    title: title
+  });
+  expect(screen.queryByText(title)).toBeInTheDocument();
+});
+test('should hide the modal if clicked outside when isDismissable is true', function () {
+  var onClose = jest.fn();
+  getComponent({
+    isOpen: true,
+    onClose: onClose,
+    isDismissable: true
+  });
+  expect(screen.queryByRole('dialog')).toBeInTheDocument();
+  expect(onClose).not.toHaveBeenCalled();
+  userEvent.click(document.body);
+  expect(onClose).toHaveBeenCalledTimes(1);
+});
+test('should not hide the modal if clicked outside when isDismissable is false', function () {
+  var onClose = jest.fn();
+  getComponent({
+    isOpen: true,
+    onClose: onClose
+  });
+  expect(screen.queryByRole('dialog')).toBeInTheDocument();
+  expect(onClose).not.toHaveBeenCalled();
+  userEvent.click(document.body);
+  expect(onClose).not.toHaveBeenCalledTimes(1);
+});
+test('should hide the overlay when clicking outside if shouldCloseOnInteractOutside returns true', function () {
+  var onClose = jest.fn();
+
+  var shouldCloseOnInteractOutside = function shouldCloseOnInteractOutside(target) {
+    return target === document.body;
+  };
+
+  getComponent({
+    isOpen: true,
+    isDismissable: true,
+    onClose: onClose,
+    shouldCloseOnInteractOutside: shouldCloseOnInteractOutside
+  });
+  expect(onClose).not.toHaveBeenCalled();
+  userEvent.click(document.body);
+  expect(onClose).toHaveBeenCalledTimes(1);
+});
+test('should not hide the overlay when clicking outside if shouldCloseOnInteractOutside returns false', function () {
+  var onClose = jest.fn();
+
+  var shouldCloseOnInteractOutside = function shouldCloseOnInteractOutside(target) {
+    return target !== document.body;
+  };
+
+  getComponent({
+    isOpen: true,
+    isDismissable: true,
+    onClose: onClose,
+    shouldCloseOnInteractOutside: shouldCloseOnInteractOutside
+  });
+  expect(onClose).not.toHaveBeenCalled();
+  userEvent.click(document.body);
+  expect(onClose).not.toHaveBeenCalledTimes(1);
+});
+test('should hide the overlay when pressing the escape key', function () {
+  var onClose = jest.fn(); // isDismissable does not need to be true here
+
+  getComponent({
+    isOpen: true,
+    onClose: onClose
+  });
+  var modal = screen.getByRole('dialog');
+  expect(onClose).not.toHaveBeenCalled();
+  userEvent.type(modal, '{esc}');
+  expect(onClose).toHaveBeenCalledTimes(1);
+});
+test('should only hide the top-most overlay', function () {
+  var onCloseFirst = jest.fn();
+  var onCloseSecond = jest.fn();
+  getComponent({
+    isOpen: true,
+    onClose: onCloseFirst,
+    isDismissable: true
+  });
+
+  var _getComponent = getComponent({
+    isOpen: true,
+    onClose: onCloseSecond,
+    isDismissable: true
+  }),
+      unmount = _getComponent.unmount;
+
+  userEvent.click(document.body);
+  expect(onCloseSecond).toHaveBeenCalledTimes(1);
+  expect(onCloseFirst).not.toHaveBeenCalled();
+  unmount();
+  userEvent.click(document.body);
+  expect(onCloseFirst).toHaveBeenCalledTimes(1);
+});
+test('should render a close button if hasCloseButton is true', function () {
+  getComponent({
+    hasCloseButton: true
+  });
+  expect(screen.queryByRole('button')).toBeInTheDocument();
+});
+test('should render a custom close button if hasCloseButton is true and custom button is provided', function () {
+  var MyButton = function MyButton() {
+    return ___EmotionJSX("div", {
+      "data-testid": "test"
+    });
+  };
+
+  getComponent({
+    hasCloseButton: true,
+    closeButton: ___EmotionJSX(MyButton, null)
+  });
+  expect(screen.queryByRole('button')).not.toBeInTheDocument();
+  expect(screen.queryByTestId('test')).toBeInTheDocument();
+});
+test('shouldn\'t auto focus the first tabbable element', function () {
+  getComponent({
+    hasCloseButton: true
+  });
+  var button = screen.queryByRole('button');
+  expect(button).not.toHaveFocus();
+});
+test('should auto focus the first tabbable element if "hasAutoFocus" is true', function () {
+  getComponent({
+    hasCloseButton: true,
+    hasAutoFocus: true
+  });
+  var button = screen.queryByRole('button');
+  expect(button).toHaveFocus();
+});