@carbon/react 0.17.0 → 1.0.0-rc.0

package/lib/components/Modal/Modal.js

@@ -0,0 +1,353 @@
+/**
+ * Copyright IBM Corp. 2016, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
+var PropTypes = require('prop-types');
+var React = require('react');
+var cx = require('classnames');
+var iconsReact = require('@carbon/icons-react');
+var toggleClass = require('../../tools/toggleClass.js');
+var Button = require('../Button/Button.js');
+var ButtonSet = require('../ButtonSet/ButtonSet.js');
+var deprecate = require('../../prop-types/deprecate.js');
+var requiredIfGivenPropIsTruthy = require('../../prop-types/requiredIfGivenPropIsTruthy.js');
+var wrapFocus = require('../../internal/wrapFocus.js');
+var setupGetInstanceId = require('../../tools/setupGetInstanceId.js');
+var usePrefix = require('../../internal/usePrefix.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+
+var _defineProperty2;
+
+var _excluded = ["modalHeading", "modalLabel", "modalAriaLabel", "passiveModal", "hasForm", "secondaryButtonText", "primaryButtonText", "open", "onRequestClose", "onRequestSubmit", "onSecondarySubmit", "iconDescription", "primaryButtonDisabled", "danger", "alert", "secondaryButtons", "selectorPrimaryFocus", "selectorsFloatingMenus", "shouldSubmitOnEnter", "size", "hasScrollingContent", "closeButtonLabel", "preventCloseOnClickOutside"];
+var getInstanceId = setupGetInstanceId["default"]();
+
+var Modal = /*#__PURE__*/function (_Component) {
+  _rollupPluginBabelHelpers.inherits(Modal, _Component);
+
+  var _super = _rollupPluginBabelHelpers.createSuper(Modal);
+
+  function Modal() {
+    var _this;
+
+    _rollupPluginBabelHelpers.classCallCheck(this, Modal);
+
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    _this = _super.call.apply(_super, [this].concat(args));
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "button", /*#__PURE__*/React__default["default"].createRef());
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "secondaryButton", /*#__PURE__*/React__default["default"].createRef());
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "outerModal", /*#__PURE__*/React__default["default"].createRef());
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "innerModal", /*#__PURE__*/React__default["default"].createRef());
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "startTrap", /*#__PURE__*/React__default["default"].createRef());
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "endTrap", /*#__PURE__*/React__default["default"].createRef());
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "modalInstanceId", "modal-".concat(getInstanceId()));
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "modalLabelId", "".concat(_this.context, "--modal-header__label--").concat(_this.modalInstanceId));
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "modalHeadingId", "".concat(_this.context, "--modal-header__heading--").concat(_this.modalInstanceId));
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "modalBodyId", "".concat(_this.context, "--modal-body--").concat(_this.modalInstanceId));
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "modalCloseButtonClass", "".concat(_this.context, "--modal-close"));
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "isCloseButton", function (element) {
+      return !_this.props.onSecondarySubmit && element === _this.secondaryButton.current || element.classList.contains(_this.modalCloseButtonClass);
+    });
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "handleKeyDown", function (evt) {
+      if (_this.props.open) {
+        if (evt.which === 27) {
+          _this.props.onRequestClose(evt);
+        }
+
+        if (evt.which === 13 && _this.props.shouldSubmitOnEnter && !_this.isCloseButton(evt.target)) {
+          _this.props.onRequestSubmit(evt);
+        }
+      }
+    });
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "handleMousedown", function (evt) {
+      if (_this.innerModal.current && !_this.innerModal.current.contains(evt.target) && !wrapFocus.elementOrParentIsFloatingMenu(evt.target, _this.props.selectorsFloatingMenus) && !_this.props.preventCloseOnClickOutside) {
+        _this.props.onRequestClose(evt);
+      }
+    });
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "handleBlur", function (_ref) {
+      var oldActiveNode = _ref.target,
+          currentActiveNode = _ref.relatedTarget;
+      var _this$props = _this.props,
+          open = _this$props.open,
+          selectorsFloatingMenus = _this$props.selectorsFloatingMenus;
+
+      if (open && currentActiveNode && oldActiveNode) {
+        var bodyNode = _this.innerModal.current;
+        var startTrapNode = _this.startTrap.current;
+        var endTrapNode = _this.endTrap.current;
+        wrapFocus["default"]({
+          bodyNode: bodyNode,
+          startTrapNode: startTrapNode,
+          endTrapNode: endTrapNode,
+          currentActiveNode: currentActiveNode,
+          oldActiveNode: oldActiveNode,
+          selectorsFloatingMenus: selectorsFloatingMenus
+        });
+      }
+    });
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "initialFocus", function (focusContainerElement) {
+      var containerElement = focusContainerElement || _this.innerModal.current;
+      var primaryFocusElement = containerElement ? containerElement.querySelector(_this.props.selectorPrimaryFocus) : null;
+
+      if (primaryFocusElement) {
+        return primaryFocusElement;
+      }
+
+      return _this.button && _this.button.current;
+    });
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "focusButton", function (focusContainerElement) {
+      var target = _this.initialFocus(focusContainerElement);
+
+      if (target) {
+        target.focus();
+      }
+    });
+
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.assertThisInitialized(_this), "handleTransitionEnd", function (evt) {
+      if (evt.target === evt.currentTarget && // Not to handle `onTransitionEnd` on child DOM nodes
+      _this.outerModal.current && _this.outerModal.current.offsetWidth && _this.outerModal.current.offsetHeight && _this.beingOpen) {
+        _this.focusButton(evt.currentTarget);
+
+        _this.beingOpen = false;
+      }
+    });
+
+    return _this;
+  }
+
+  _rollupPluginBabelHelpers.createClass(Modal, [{
+    key: "componentDidUpdate",
+    value: function componentDidUpdate(prevProps) {
+      if (!prevProps.open && this.props.open) {
+        this.beingOpen = true;
+      } else if (prevProps.open && !this.props.open) {
+        this.beingOpen = false;
+      }
+
+      toggleClass["default"](document.body, "".concat(this.context, "--body--with-modal-open"), this.props.open);
+    }
+  }, {
+    key: "componentWillUnmount",
+    value: function componentWillUnmount() {
+      toggleClass["default"](document.body, "".concat(this.context, "--body--with-modal-open"), false);
+    }
+  }, {
+    key: "componentDidMount",
+    value: function componentDidMount() {
+      toggleClass["default"](document.body, "".concat(this.context, "--body--with-modal-open"), this.props.open);
+
+      if (!this.props.open) {
+        return;
+      }
+
+      this.focusButton(this.innerModal.current);
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      var _classNames, _classNames3;
+
+      var _this$props2 = this.props,
+          modalHeading = _this$props2.modalHeading,
+          modalLabel = _this$props2.modalLabel,
+          modalAriaLabel = _this$props2.modalAriaLabel,
+          passiveModal = _this$props2.passiveModal,
+          hasForm = _this$props2.hasForm,
+          secondaryButtonText = _this$props2.secondaryButtonText,
+          primaryButtonText = _this$props2.primaryButtonText,
+          open = _this$props2.open,
+          onRequestClose = _this$props2.onRequestClose,
+          onRequestSubmit = _this$props2.onRequestSubmit,
+          onSecondarySubmit = _this$props2.onSecondarySubmit,
+          iconDescription = _this$props2.iconDescription,
+          primaryButtonDisabled = _this$props2.primaryButtonDisabled,
+          danger = _this$props2.danger,
+          alert = _this$props2.alert,
+          secondaryButtons = _this$props2.secondaryButtons;
+          _this$props2.selectorPrimaryFocus;
+          _this$props2.selectorsFloatingMenus;
+          _this$props2.shouldSubmitOnEnter;
+          var size = _this$props2.size,
+          hasScrollingContent = _this$props2.hasScrollingContent,
+          closeButtonLabel = _this$props2.closeButtonLabel;
+          _this$props2.preventCloseOnClickOutside;
+          var other = _rollupPluginBabelHelpers.objectWithoutProperties(_this$props2, _excluded);
+
+      var prefix = this.context;
+      var onSecondaryButtonClick = onSecondarySubmit ? onSecondarySubmit : onRequestClose;
+      var modalClasses = cx__default["default"]((_classNames = {}, _rollupPluginBabelHelpers.defineProperty(_classNames, "".concat(prefix, "--modal"), true), _rollupPluginBabelHelpers.defineProperty(_classNames, "".concat(prefix, "--modal-tall"), !passiveModal), _rollupPluginBabelHelpers.defineProperty(_classNames, 'is-visible', open), _rollupPluginBabelHelpers.defineProperty(_classNames, "".concat(prefix, "--modal--danger"), this.props.danger), _rollupPluginBabelHelpers.defineProperty(_classNames, this.props.className, this.props.className), _classNames));
+      var containerClasses = cx__default["default"]("".concat(prefix, "--modal-container"), _rollupPluginBabelHelpers.defineProperty({}, "".concat(prefix, "--modal-container--").concat(size), size));
+      var contentClasses = cx__default["default"]("".concat(prefix, "--modal-content"), (_classNames3 = {}, _rollupPluginBabelHelpers.defineProperty(_classNames3, "".concat(prefix, "--modal-content--with-form"), hasForm), _rollupPluginBabelHelpers.defineProperty(_classNames3, "".concat(prefix, "--modal-scroll-content"), hasScrollingContent), _classNames3));
+      var footerClasses = cx__default["default"]("".concat(prefix, "--modal-footer"), _rollupPluginBabelHelpers.defineProperty({}, "".concat(prefix, "--modal-footer--three-button"), Array.isArray(secondaryButtons) && secondaryButtons.length === 2));
+      var modalButton = /*#__PURE__*/React__default["default"].createElement("button", {
+        className: this.modalCloseButtonClass,
+        type: "button",
+        onClick: onRequestClose,
+        title: ariaLabel ? ariaLabel : iconDescription,
+        "aria-label": closeButtonLabel ? closeButtonLabel : 'close',
+        ref: this.button
+      }, /*#__PURE__*/React__default["default"].createElement(iconsReact.Close, {
+        size: 20,
+        "aria-hidden": "true",
+        tabIndex: "-1",
+        className: "".concat(this.modalCloseButtonClass, "__icon")
+      }));
+      var ariaLabel = modalLabel || this.props['aria-label'] || modalAriaLabel || modalHeading;
+      var getAriaLabelledBy = modalLabel ? this.modalLabelId : this.modalHeadingId;
+      var hasScrollingContentProps = hasScrollingContent ? {
+        tabIndex: 0,
+        role: 'region',
+        'aria-label': ariaLabel,
+        'aria-labelledby': getAriaLabelledBy
+      } : {};
+      var alertDialogProps = {};
+
+      if (alert && passiveModal) {
+        alertDialogProps.role = 'alert';
+      }
+
+      if (alert && !passiveModal) {
+        alertDialogProps.role = 'alertdialog';
+        alertDialogProps['aria-describedby'] = this.modalBodyId;
+      }
+
+      var modalBody = /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({
+        ref: this.innerModal,
+        role: "dialog"
+      }, alertDialogProps, {
+        className: containerClasses,
+        "aria-label": ariaLabel,
+        "aria-modal": "true",
+        tabIndex: "-1"
+      }), /*#__PURE__*/React__default["default"].createElement("div", {
+        className: "".concat(prefix, "--modal-header")
+      }, passiveModal && modalButton, modalLabel && /*#__PURE__*/React__default["default"].createElement("h2", {
+        id: this.modalLabelId,
+        className: "".concat(prefix, "--modal-header__label")
+      }, modalLabel), /*#__PURE__*/React__default["default"].createElement("h3", {
+        id: this.modalHeadingId,
+        className: "".concat(prefix, "--modal-header__heading")
+      }, modalHeading), !passiveModal && modalButton), /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({
+        id: this.modalBodyId,
+        className: contentClasses
+      }, hasScrollingContentProps, {
+        "aria-labelledby": getAriaLabelledBy
+      }), this.props.children), hasScrollingContent && /*#__PURE__*/React__default["default"].createElement("div", {
+        className: "".concat(prefix, "--modal-content--overflow-indicator")
+      }), !passiveModal && /*#__PURE__*/React__default["default"].createElement(ButtonSet["default"], {
+        className: footerClasses
+      }, Array.isArray(secondaryButtons) && secondaryButtons.length <= 2 ? secondaryButtons.map(function (_ref2, i) {
+        var buttonText = _ref2.buttonText,
+            onButtonClick = _ref2.onClick;
+        return /*#__PURE__*/React__default["default"].createElement(Button["default"], {
+          key: "".concat(buttonText, "-").concat(i),
+          kind: "secondary",
+          onClick: onButtonClick
+        }, buttonText);
+      }) : secondaryButtonText && /*#__PURE__*/React__default["default"].createElement(Button["default"], {
+        kind: "secondary",
+        onClick: onSecondaryButtonClick,
+        ref: this.secondaryButton
+      }, secondaryButtonText), /*#__PURE__*/React__default["default"].createElement(Button["default"], {
+        kind: danger ? 'danger' : 'primary',
+        disabled: primaryButtonDisabled,
+        onClick: onRequestSubmit,
+        ref: this.button
+      }, primaryButtonText)));
+      return /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, other, {
+        onKeyDown: this.handleKeyDown,
+        onMouseDown: this.handleMousedown,
+        onBlur: this.handleBlur,
+        className: modalClasses,
+        role: "presentation",
+        onTransitionEnd: this.props.open ? this.handleTransitionEnd : undefined,
+        ref: this.outerModal
+      }), /*#__PURE__*/React__default["default"].createElement("span", {
+        ref: this.startTrap,
+        tabIndex: "0",
+        role: "link",
+        className: "".concat(prefix, "--visually-hidden")
+      }, "Focus sentinel"), modalBody, /*#__PURE__*/React__default["default"].createElement("span", {
+        ref: this.endTrap,
+        tabIndex: "0",
+        role: "link",
+        className: "".concat(prefix, "--visually-hidden")
+      }, "Focus sentinel"));
+    }
+  }]);
+
+  return Modal;
+}(React.Component);
+
+_rollupPluginBabelHelpers.defineProperty(Modal, "contextType", usePrefix.PrefixContext);
+
+_rollupPluginBabelHelpers.defineProperty(Modal, "propTypes", (_defineProperty2 = {
+  /**
+   * Specify whether the Modal is displaying an alert, error or warning
+   * Should go hand in hand with the danger prop.
+   */
+  alert: PropTypes__default["default"].bool
+}, _rollupPluginBabelHelpers.defineProperty(_defineProperty2, 'aria-label', requiredIfGivenPropIsTruthy["default"]('hasScrollingContent', PropTypes__default["default"].string)), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "children", PropTypes__default["default"].node), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "className", PropTypes__default["default"].string), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "closeButtonLabel", PropTypes__default["default"].string), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "danger", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "focusTrap", deprecate["default"](PropTypes__default["default"].bool, "\nThe prop `focusTrap` for Modal has been deprecated, as the feature of `focusTrap` runs by default.")), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "hasForm", deprecate["default"](PropTypes__default["default"].bool, "\nThe prop `hasForm` for Modal has been deprecated, as the feature of `hasForm` runs by default.")), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "hasScrollingContent", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "iconDescription", deprecate["default"](PropTypes__default["default"].string, 'The iconDescription prop is no longer needed and can be safely removed. This prop will be removed in the next major release of Carbon.')), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "id", PropTypes__default["default"].string), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "modalAriaLabel", PropTypes__default["default"].string), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "modalHeading", PropTypes__default["default"].node), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "modalLabel", PropTypes__default["default"].node), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "onKeyDown", PropTypes__default["default"].func), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "onRequestClose", PropTypes__default["default"].func), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "onRequestSubmit", PropTypes__default["default"].func), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "onSecondarySubmit", PropTypes__default["default"].func), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "open", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "passiveModal", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "preventCloseOnClickOutside", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "primaryButtonDisabled", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "primaryButtonText", PropTypes__default["default"].node), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "secondaryButtonText", PropTypes__default["default"].node), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "secondaryButtons", function secondaryButtons(props, propName, componentName) {
+  if (props.secondaryButtons) {
+    if (!Array.isArray(props.secondaryButtons) || props.secondaryButtons.length !== 2) {
+      return new Error("".concat(propName, " needs to be an array of two button config objects"));
+    }
+
+    var shape = {
+      buttonText: PropTypes__default["default"].node,
+      onClick: PropTypes__default["default"].func
+    };
+    props[propName].forEach(function (secondaryButton) {
+      PropTypes__default["default"].checkPropTypes(shape, secondaryButton, propName, componentName);
+    });
+  }
+
+  return null;
+}), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "selectorPrimaryFocus", PropTypes__default["default"].string), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "selectorsFloatingMenus", PropTypes__default["default"].arrayOf(PropTypes__default["default"].string)), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "shouldSubmitOnEnter", PropTypes__default["default"].bool), _rollupPluginBabelHelpers.defineProperty(_defineProperty2, "size", PropTypes__default["default"].oneOf(['xs', 'sm', 'md', 'lg'])), _defineProperty2));
+
+_rollupPluginBabelHelpers.defineProperty(Modal, "defaultProps", {
+  onRequestClose: function onRequestClose() {},
+  onRequestSubmit: function onRequestSubmit() {},
+  primaryButtonDisabled: false,
+  onKeyDown: function onKeyDown() {},
+  passiveModal: false,
+  modalHeading: '',
+  modalLabel: '',
+  preventCloseOnClickOutside: false,
+  selectorPrimaryFocus: '[data-modal-primary-focus]',
+  hasScrollingContent: false
+});
+
+exports["default"] = Modal;

package/lib/components/Modal/index.js

@@ -0,0 +1,39 @@
+/**
+ * Copyright IBM Corp. 2016, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var FeatureFlags = require('@carbon/feature-flags');
+var Modal$2 = require('./next/Modal.js');
+var Modal$3 = require('./Modal.js');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var FeatureFlags__namespace = /*#__PURE__*/_interopNamespace(FeatureFlags);
+
+var Modal = FeatureFlags__namespace.enabled('enable-v11-release') ? Modal$2["default"] : Modal$3["default"];
+var Modal$1 = Modal;
+
+exports["default"] = Modal$1;