@carbon/ibm-products 2.0.0-rc.3 → 2.0.0-rc.32

package/lib/components/AboutModal/AboutModal.js

@@ -1,53 +1,42 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AboutModal = void 0;
-
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
 var _react = _interopRequireWildcard(require("react"));
-
-var _reactResizeDetector = require("react-resize-detector");
-
+var _useResizeObserver = require("../../global/js/hooks/useResizeObserver");
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _classnames = _interopRequireDefault(require("classnames"));
-
 var _settings = require("../../settings");
-
 var _uuidv = _interopRequireDefault(require("../../global/js/utils/uuidv4"));
-
 var _devtools = require("../../global/js/utils/devtools");
-
 var _react2 = require("@carbon/react");
-
-var _propsHelper = require("../../global/js/utils/props-helper");
-
-var _excluded = ["additionalInfo", "className", "closeIconDescription", "content", "copyrightText", "legalText", "links", "logo", "modalAriaLabel", "onClose", "open", "tabListAriaLabel", "title"];
-
+var _excluded = ["additionalInfo", "className", "closeIconDescription", "copyrightText", "content", "links", "logo", "modalAriaLabel", "onClose", "open", "title", "version"];
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+// Carbon and package components we use.
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(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 source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.pkg.prefix, "--about-modal");
-var componentName = 'AboutModal'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+var componentName = 'AboutModal';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
 
 /**
  * The AboutModal component provides a way to communicate product information
@@ -56,52 +45,51 @@ var componentName = 'AboutModal'; // NOTE: the component SCSS is not imported he
  * should be immediately apparent to the user, with a clear and obvious path
  * to completion.
  */
-
 var AboutModal = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var additionalInfo = _ref.additionalInfo,
-      className = _ref.className,
-      closeIconDescription = _ref.closeIconDescription,
-      content = _ref.content,
-      copyrightText = _ref.copyrightText,
-      legalText = _ref.legalText,
-      links = _ref.links,
-      logo = _ref.logo,
-      modalAriaLabel = _ref.modalAriaLabel,
-      onClose = _ref.onClose,
-      open = _ref.open,
-      tabListAriaLabel = _ref.tabListAriaLabel,
-      title = _ref.title,
-      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
-
+    className = _ref.className,
+    closeIconDescription = _ref.closeIconDescription,
+    copyrightText = _ref.copyrightText,
+    content = _ref.content,
+    links = _ref.links,
+    logo = _ref.logo,
+    modalAriaLabel = _ref.modalAriaLabel,
+    onClose = _ref.onClose,
+    open = _ref.open,
+    title = _ref.title,
+    version = _ref.version,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
   var _useState = (0, _react.useState)(true),
-      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-      hasScrollingContent = _useState2[0],
-      setHasScrollingContent = _useState2[1];
-
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    hasScrollingContent = _useState2[0],
+    setHasScrollingContent = _useState2[1];
   var bodyRef = (0, _react.useRef)();
   var contentRef = (0, _react.useRef)();
   var contentId = (0, _uuidv.default)();
-
   var handleResize = function handleResize() {
-    setHasScrollingContent( // if our scroll height exceeds the client height enable scrolling
-    bodyRef.current.clientHeight < (hasScrollingContent ? // Carbon modal adds 32px bottom margin when scrolling content is enabled
+    setHasScrollingContent(
+    // if our scroll height exceeds the client height enable scrolling
+    bodyRef.current.clientHeight < (hasScrollingContent ?
+    // Carbon modal adds 32px bottom margin when scrolling content is enabled
     bodyRef.current.scrollHeight - 32 : bodyRef.current.scrollHeight));
-  }; // We can't add a ref directly to the ModalBody, so track it in a ref
-  // as the parent of the current bodyRef element
-
+  };
 
+  // We can't add a ref directly to the ModalBody, so track it in a ref
+  // as the parent of the current bodyRef element
   (0, _react.useEffect)(function () {
     bodyRef.current = contentRef.current.parentElement;
-  }, [bodyRef]); // Detect resize of the ModalBody to recalculate whether scrolling is enabled
+  }, [bodyRef]);
 
-  (0, _reactResizeDetector.useResizeDetector)({
-    onResize: handleResize,
-    targetRef: bodyRef
+  // Detect resize of the ModalBody to recalculate whether scrolling is enabled
+  (0, _useResizeObserver.useResizeObserver)(bodyRef, {
+    callback: handleResize
   });
   return /*#__PURE__*/_react.default.createElement(_react2.ComposedModal, (0, _extends2.default)({}, rest, {
-    className: (0, _classnames.default)(blockClass, // Apply the block class to the main HTML element
-    className, // Apply any supplied class names to the main HTML element.
-    (0, _defineProperty2.default)({}, "".concat(blockClass, "--with-tabs"), additionalInfo && additionalInfo.length > 1)),
+    className: (0, _classnames.default)(blockClass,
+    // Apply the block class to the main HTML element
+    className // Apply any supplied class names to the main HTML element.
+    ),
+
     "aria-label": modalAriaLabel
   }, _objectSpread({
     onClose: onClose,
@@ -124,127 +112,90 @@ var AboutModal = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
     className: "".concat(blockClass, "__body-content"),
     ref: contentRef,
     id: contentId
-  }, content, /*#__PURE__*/_react.default.createElement("div", {
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__version")
+  }, version), links && links.length > 0 && /*#__PURE__*/_react.default.createElement("div", {
     className: "".concat(blockClass, "__links-container")
-  }, links && links.length > 0 && links.map(function (link, i) {
+  }, links.map(function (link, i) {
     return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, {
       key: i
     }, link);
-  })), legalText && /*#__PURE__*/_react.default.createElement("p", {
-    className: "".concat(blockClass, "__legal-text")
-  }, legalText), copyrightText && /*#__PURE__*/_react.default.createElement("p", {
+  })), content && /*#__PURE__*/_react.default.createElement("p", {
+    className: "".concat(blockClass, "__content")
+  }, content), copyrightText && /*#__PURE__*/_react.default.createElement("p", {
     className: "".concat(blockClass, "__copyright-text")
-  }, copyrightText))), /*#__PURE__*/_react.default.createElement(_react2.ModalFooter, {
+  }, copyrightText))), additionalInfo && /*#__PURE__*/_react.default.createElement(_react2.Theme, {
+    theme: "g100"
+  }, /*#__PURE__*/_react.default.createElement(_react2.ModalFooter, {
     className: "".concat(blockClass, "__footer")
-  }, additionalInfo && additionalInfo.length > 0 && (additionalInfo.length === 1 ? /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("p", {
-    className: "".concat(blockClass, "__version-label")
-  }, additionalInfo[0].label), /*#__PURE__*/_react.default.createElement("p", {
-    className: "".concat(blockClass, "__version-number")
-  }, additionalInfo[0].content)) : /*#__PURE__*/_react.default.createElement("div", {
-    className: "".concat(blockClass, "__tab-container")
-  }, /*#__PURE__*/_react.default.createElement(_react2.Tabs, null, /*#__PURE__*/_react.default.createElement(_react2.TabList, {
-    "aria-label": tabListAriaLabel
-  }, additionalInfo.map(function (tab, index) {
-    return /*#__PURE__*/_react.default.createElement(_react2.Tab, {
-      key: index
-    }, tab.label);
-  })), /*#__PURE__*/_react.default.createElement(_react2.TabPanels, null, additionalInfo.map(function (tab, index) {
-    return /*#__PURE__*/_react.default.createElement(_react2.TabPanel, {
-      key: index
-    }, tab.content);
-  })))))));
-}); // Return a placeholder if not released and not enabled by feature flag
-
+  }, additionalInfo)));
+});
 
+// Return a placeholder if not released and not enabled by feature flag
 exports.AboutModal = AboutModal;
 exports.AboutModal = AboutModal = _settings.pkg.checkComponentEnabled(AboutModal, componentName);
 AboutModal.displayName = componentName;
 
-var tabListAriaLabelRequiredProps = function tabListAriaLabelRequiredProps(type) {
-  return (0, _propsHelper.isRequiredIf)(type, function (_ref2) {
-    var additionalInfo = _ref2.additionalInfo;
-    return additionalInfo === null || additionalInfo === void 0 ? void 0 : additionalInfo.length;
-  });
-}; // The types and DocGen commentary for the component props,
+// The types and DocGen commentary for the component props,
 // in alphabetical order (for consistency).
 // See https://www.npmjs.com/package/prop-types#usage.
-
-
 AboutModal.propTypes = {
   /**
-   * Additional information to be displayed in the footer. Can be used for
-   * version information and/or a set of tabs with various contents. If only
-   * one set of additional information is provided then no tabs are
-   * displayed and the label and content are just displayed one above the
-   * other in the footer.
+   * If you are legally required to display logos of technologies used
+   * to build your product you can provide this in the additionalInfo.
+   * Additional information will be displayed in the footer.
    */
-  additionalInfo: _propTypes.default.arrayOf(_propTypes.default.shape({
-    label: _propTypes.default.string,
-    content: _propTypes.default.node
-  })),
-
+  additionalInfo: _propTypes.default.node,
   /**
    * Provide an optional class to be applied to the modal root node.
    */
   className: _propTypes.default.string,
-
   /**
    * The accessibility title for the close icon.
    */
   closeIconDescription: _propTypes.default.string.isRequired,
-
   /**
-   * A summary that appears immediately beneath the title, and might
-   * include information such as: version name, server name,
-   * user name, user role, browser version, browser OS etc.
+   * Subhead text providing any relevant product disclaimers including
+   * legal information (optional)
    */
-  content: _propTypes.default.node.isRequired,
-
+  content: _propTypes.default.node,
   /**
-   * Trademark and copyright information. Suggested format for copyright -
-   * "Copyright © 2018 Company".
+   * Trademark and copyright information. Displays first year of
+   * product release to current year.
    */
-  copyrightText: _propTypes.default.node,
-
-  /**
-   * Text providing legal information.
-   */
-  legalText: _propTypes.default.node,
-
+  copyrightText: _propTypes.default.string.isRequired,
   /**
-   * An array of Carbon `Link` components that contain links to additional
-   * information.
+   * An array of Carbon `Link` component if there are additional information
+   * to call out within the card. The about modal should be used to display
+   * the product information and not where users go to find help (optional)
    */
   links: _propTypes.default.arrayOf(_propTypes.default.element),
-
   /**
    * A visual symbol used to represent the product.
    */
   logo: _propTypes.default.node.isRequired,
-
   /**
    * Specifies aria label for AboutModal
    */
   modalAriaLabel: _propTypes.default.string,
-
   /**
    * Specifies an optional handler which is called when the AboutModal
    * is closed. Returning `false` prevents the AboutModal from closing.
    */
   onClose: _propTypes.default.func,
-
   /**
    * Specifies whether the AboutModal is open or not.
    */
   open: _propTypes.default.bool,
-
   /**
-   * Specifies the tab list aria label
+   * Header text that provides the product name. The IBM Services logo
+   * consists of two discrete, but required, elements: the iconic
+   * IBM 8-bar logo represented alongside the IBM Services logotype.
+   * Please follow these guidelines to ensure proper execution.
    */
-  tabListAriaLabel: tabListAriaLabelRequiredProps(_propTypes.default.string),
-
+  title: _propTypes.default.node.isRequired,
   /**
-   * The title of the AboutModal is usually the product or service name.
+   * Text that provides information on the version number of your product.
    */
-  title: _propTypes.default.node.isRequired
+  version: _propTypes.default.string.isRequired
 };

package/lib/components/AboutModal/index.js

@@ -9,5 +9,4 @@ Object.defineProperty(exports, "AboutModal", {
     return _AboutModal.AboutModal;
   }
 });
-
 var _AboutModal = require("./AboutModal");