@carbon/ibm-products 1.12.0 → 1.15.0

package/es/components/MultiAddSelect/MultiAddSelect.js

@@ -1,6 +1,6 @@
 import _extends from "@babel/runtime/helpers/extends";
-import React, { forwardRef } from 'react'; // import PropTypes from 'prop-types';
-
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
 import { AddSelect } from '../AddSelect';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { pkg } from '../../settings';
@@ -12,5 +12,152 @@ export var MultiAddSelect = /*#__PURE__*/forwardRef(function (props, ref) {
   }, getDevtoolsProps(componentName)));
 });
 MultiAddSelect = pkg.checkComponentEnabled(MultiAddSelect, componentName);
-MultiAddSelect.propTypes = {};
+MultiAddSelect.propTypes = {
+  /**
+   * optional class name
+   */
+  className: PropTypes.string,
+
+  /**
+   * placeholder for column input filter
+   */
+  columnInputPlaceholder: PropTypes.string,
+
+  /**
+   * text description that appears under the title
+   */
+  description: PropTypes.string,
+
+  /**
+   * options to display in the global filter box. values are generated
+   * from the id which should correlate with a specific property in an
+   * item entry
+   */
+  globalFilters: PropTypes.arrayOf(PropTypes.shape({
+    id: PropTypes.string,
+    label: PropTypes.string
+  })),
+  globalFiltersIconDescription: PropTypes.string,
+
+  /**
+   * placeholder text for the global filter dropdown
+   */
+  globalFiltersPlaceholderText: PropTypes.string,
+
+  /**
+   * text for the global filter primary button
+   */
+  globalFiltersPrimaryButtonText: PropTypes.string,
+
+  /**
+   * text for the global filter secondary button
+   */
+  globalFiltersSecondaryButtonText: PropTypes.string,
+
+  /**
+   * label for global search input
+   */
+  globalSearchLabel: PropTypes.string,
+
+  /**
+   * placeholder for global search input
+   */
+  globalSearchPlaceholder: PropTypes.string,
+
+  /**
+   * title that displays in the sidebar / influencer
+   */
+  influencerTitle: PropTypes.string,
+
+  /**
+   * object that contains the item data. for more information reference the
+   * "Structuring items" section in the docs tab
+   */
+  items: PropTypes.shape({
+    modifiers: PropTypes.shape({
+      label: PropTypes.string,
+      options: PropTypes.array
+    }),
+    sortBy: PropTypes.array,
+    filterBy: PropTypes.array,
+    entries: PropTypes.arrayOf(PropTypes.shape({
+      avatar: PropTypes.shape({
+        alt: PropTypes.string,
+        icon: PropTypes.object,
+        src: PropTypes.string
+      }),
+      children: PropTypes.object,
+      icon: PropTypes.object,
+      id: PropTypes.string.isRequired,
+      subtitle: PropTypes.string,
+      title: PropTypes.string.isRequired,
+      value: PropTypes.string.isRequired
+    }))
+  }),
+
+  /**
+   * label that display above the list of items
+   */
+  itemsLabel: PropTypes.string,
+
+  /**
+   * text to display when no results are found from the global search
+   */
+  noResultsDescription: PropTypes.string,
+
+  /**
+   * title to display when no results are found from the global search
+   */
+  noResultsTitle: PropTypes.string,
+
+  /**
+   * text body that displays in the sidebar when nothing is selected
+   */
+  noSelectionDescription: PropTypes.string,
+
+  /**
+   * title that displays in the sidebar when nothing is selected
+   */
+  noSelectionTitle: PropTypes.string,
+
+  /**
+   * function to call when the close button clicked
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * text for close button
+   */
+  onCloseButtonText: PropTypes.string,
+
+  /**
+   * function to call when the submit button is clicked. returns a selection
+   */
+  onSubmit: PropTypes.func,
+
+  /**
+   * text for the submit button
+   */
+  onSubmitButtonText: PropTypes.string,
+
+  /**
+   * specifies if the component is open or not
+   */
+  open: PropTypes.bool,
+
+  /**
+   * description for the remove item icon
+   */
+  removeIconDescription: PropTypes.string,
+
+  /**
+   * text that displays when displaying filtered items
+   */
+  searchResultsLabel: PropTypes.string,
+
+  /**
+   * header text
+   */
+  title: PropTypes.string
+};
 MultiAddSelect.displayName = componentName;

package/es/components/PageHeader/PageHeader.js

@@ -499,7 +499,8 @@ var TYPES = {
   gray: 'Gray',
   'cool-gray': 'Cool-Gray',
   'warm-gray': 'Warm-Gray',
-  'high-contrast': 'High-Contrast'
+  'high-contrast': 'High-Contrast',
+  outline: 'Outline'
 };
 var tagTypes = Object.keys(TYPES);
 export var deprecatedProps = {
@@ -513,6 +514,7 @@ export var deprecatedProps = {
    */
   hasBackgroundAlways: deprecateProp(PropTypes.bool, 'Property replaced by `withoutBackground`')
 };
+PageHeader.tagTypes = tagTypes;
 PageHeader.propTypes = _objectSpread({
   /**
    * Specifies the action bar items which are the final items in the row top of the PageHeader.

package/es/components/SingleAddSelect/SingleAddSelect.js

@@ -1,15 +1,101 @@
 import _extends from "@babel/runtime/helpers/extends";
-import React, { forwardRef } from 'react'; // import PropTypes from 'prop-types';
-
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
 import { AddSelect } from '../AddSelect';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { pkg } from '../../settings';
+import { prepareProps } from '../../global/js/utils/props-helper';
 var componentName = 'SingleAddSelect';
 export var SingleAddSelect = /*#__PURE__*/forwardRef(function (props, ref) {
-  return /*#__PURE__*/React.createElement(AddSelect, _extends({}, props, {
+  // remove multi add select specific props
+  var validProps = prepareProps(props, ['columnInputPlaceholder', 'globalFilters', 'globalFiltersIconDescription', 'globalFiltersPlaceholderText', 'globalFiltersPrimaryButtonText', 'globalFiltersSecondaryButtonText', 'influencerTitle', 'multi', 'noSelectionDescription', 'noSelectionTitle', 'removeIconDescription']);
+  return /*#__PURE__*/React.createElement(AddSelect, _extends({}, validProps, {
     ref: ref
   }, getDevtoolsProps(componentName)));
 });
 SingleAddSelect = pkg.checkComponentEnabled(SingleAddSelect, componentName);
-SingleAddSelect.propTypes = {};
+SingleAddSelect.propTypes = {
+  /**
+   * optional class name
+   */
+  className: PropTypes.string,
+
+  /**
+   * text description that appears under the title
+   */
+  description: PropTypes.string,
+
+  /**
+   * label for global search input
+   */
+  globalSearchLabel: PropTypes.string,
+
+  /**
+   * placeholder for global search input
+   */
+  globalSearchPlaceholder: PropTypes.string,
+
+  /**
+   * object that contains the item data. for more information reference the
+   * "Structuring items" section in the docs tab
+   */
+  items: PropTypes.shape({
+    entries: PropTypes.arrayOf(PropTypes.shape({
+      children: PropTypes.object,
+      id: PropTypes.string.isRequired,
+      title: PropTypes.string.isRequired,
+      value: PropTypes.string.isRequired
+    }))
+  }),
+
+  /**
+   * label that display above the list of items
+   */
+  itemsLabel: PropTypes.string,
+
+  /**
+   * text to display when no results are found from the global search
+   */
+  noResultsDescription: PropTypes.string,
+
+  /**
+   * title to display when no results are found from the global search
+   */
+  noResultsTitle: PropTypes.string,
+
+  /**
+   * function to call when the close button clicked
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * text for close button
+   */
+  onCloseButtonText: PropTypes.string,
+
+  /**
+   * function to call when the submit button is clicked. returns a selection
+   */
+  onSubmit: PropTypes.func,
+
+  /**
+   * text for the submit button
+   */
+  onSubmitButtonText: PropTypes.string,
+
+  /**
+   * specifies if the component is open or not
+   */
+  open: PropTypes.bool,
+
+  /**
+   * text that displays when displaying filtered items
+   */
+  searchResultsLabel: PropTypes.string,
+
+  /**
+   * header text
+   */
+  title: PropTypes.string
+};
 SingleAddSelect.displayName = componentName;

package/es/components/TagSet/TagSet.js

@@ -33,15 +33,14 @@ var allTagsModalSearchThreshold = 10; // Default values for props
 
 var defaults = {
   align: 'start',
-  allTagsModalTarget: document.body,
+  // allTagsModalTarget: document.body,
   overflowAlign: 'center',
   overflowDirection: 'bottom'
 };
 export var TagSet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var _ref$align = _ref.align,
       align = _ref$align === void 0 ? defaults.align : _ref$align,
-      _ref$allTagsModalTarg = _ref.allTagsModalTarget,
-      allTagsModalTarget = _ref$allTagsModalTarg === void 0 ? defaults.allTagsModalTarget : _ref$allTagsModalTarg,
+      allTagsModalTargetIn = _ref.allTagsModalTarget,
       className = _ref.className,
       maxVisible = _ref.maxVisible,
       _ref$overflowAlign = _ref.overflowAlign,
@@ -88,10 +87,24 @@ export var TagSet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
 
   var overflowTag = useRef(null);
 
+  var _useState11 = useState(null),
+      _useState12 = _slicedToArray(_useState11, 2),
+      allTagsModalTarget = _useState12[0],
+      setAllTagsModalTarget = _useState12[1];
+
   var handleShowAllClick = function handleShowAllClick() {
     setShowAllModalOpen(true);
   };
 
+  useEffect(function () {
+    if (allTagsModalTargetIn) {
+      setAllTagsModalTarget(allTagsModalTargetIn);
+    } else {
+      if (pkg.isFeatureEnabled('default-portal-target-body')) {
+        setAllTagsModalTarget(document.body);
+      }
+    }
+  }, [allTagsModalTargetIn]);
   useEffect(function () {
     var newSizingTags = []; // create sizing tags
 
@@ -228,14 +241,16 @@ export var TagSet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   }, hiddenSizingTags), /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__tag-container"),
     ref: displayedArea
-  }, displayedTags)), allTagsModalTarget && tags && displayCount < tags.length ? /*#__PURE__*/createPortal( /*#__PURE__*/React.createElement(TagSetModal, {
+  }, displayedTags)), (allTagsModalTarget ? createPortal : function (children) {
+    return children;
+  })( /*#__PURE__*/React.createElement(TagSetModal, {
     allTags: tags,
     open: showAllModalOpen,
     title: allTagsModalTitle,
     onClose: handleModalClose,
     searchLabel: allTagsModalSearchLabel,
     searchPlaceholder: allTagsModalSearchPlaceholderText
-  }), allTagsModalTarget) : null);
+  }), allTagsModalTarget));
 }); // Return a placeholder if not released and not enabled by feature flag
 
 TagSet = pkg.checkComponentEnabled(TagSet, componentName);
@@ -260,7 +275,8 @@ var TYPES = {
   gray: 'Gray',
   'cool-gray': 'Cool-Gray',
   'warm-gray': 'Warm-Gray',
-  'high-contrast': 'High-Contrast'
+  'high-contrast': 'High-Contrast',
+  outline: 'Outline'
 };
 var tagTypes = Object.keys(TYPES);
 TagSet.types = tagTypes;

package/es/components/Tearsheet/TearsheetShell.js

@@ -2,7 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["actions", "children", "className", "closeIconDescription", "description", "hasCloseIcon", "headerActions", "influencer", "influencerPosition", "influencerWidth", "label", "navigation", "onClose", "open", "selectorPrimaryFocus", "size", "title", "verticalPosition"];
+var _excluded = ["actions", "children", "className", "closeIconDescription", "description", "hasCloseIcon", "headerActions", "influencer", "influencerPosition", "influencerWidth", "label", "navigation", "onClose", "open", "selectorPrimaryFocus", "size", "portalTarget", "title", "verticalPosition"];
 
 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; }
 
@@ -16,6 +16,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  */
 // Import portions of React that are needed.
 import React, { useEffect, useState, useRef } from 'react';
+import { createPortal } from 'react-dom';
 import { useResizeDetector } from 'react-resize-detector'; // Other standard imports.
 
 import PropTypes from 'prop-types';
@@ -68,10 +69,26 @@ export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       open = _ref.open,
       selectorPrimaryFocus = _ref.selectorPrimaryFocus,
       size = _ref.size,
+      portalTargetIn = _ref.portalTarget,
       title = _ref.title,
       verticalPosition = _ref.verticalPosition,
       rest = _objectWithoutProperties(_ref, _excluded);
 
+  // node the modal tearsheet is hosted in
+  var _useState = useState(null),
+      _useState2 = _slicedToArray(_useState, 2),
+      portalTarget = _useState2[0],
+      setPortalTarget = _useState2[1];
+
+  useEffect(function () {
+    if (portalTargetIn) {
+      setPortalTarget(portalTargetIn);
+    } else {
+      if (pkg.isFeatureEnabled('default-portal-target-body')) {
+        setPortalTarget(document.body);
+      }
+    }
+  }, [portalTargetIn]);
   var localRef = useRef();
   var modalRef = ref || localRef;
 
@@ -82,15 +99,15 @@ export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       resizer = _useResizeDetector.ref; // Keep track of the stack depth and our position in it (1-based, 0=closed)
 
 
-  var _useState = useState(0),
-      _useState2 = _slicedToArray(_useState, 2),
-      depth = _useState2[0],
-      setDepth = _useState2[1];
-
   var _useState3 = useState(0),
       _useState4 = _slicedToArray(_useState3, 2),
-      position = _useState4[0],
-      setPosition = _useState4[1]; // Keep a record of the previous value of depth.
+      depth = _useState4[0],
+      setDepth = _useState4[1];
+
+  var _useState5 = useState(0),
+      _useState6 = _slicedToArray(_useState5, 2),
+      position = _useState6[0],
+      setPosition = _useState6[1]; // Keep a record of the previous value of depth.
 
 
   var prevDepth = useRef();
@@ -176,7 +193,9 @@ export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     var includeHeader = label || title || description || headerActions || navigation || effectiveHasCloseIcon; // Include an ActionSet if and only if one or more actions is given.
 
     var includeActions = actions && (actions === null || actions === void 0 ? void 0 : actions.length) > 0;
-    return /*#__PURE__*/React.createElement(ComposedModal, _extends({}, rest, {
+    return (portalTarget ? createPortal : function (children) {
+      return children;
+    })( /*#__PURE__*/React.createElement(ComposedModal, _extends({}, rest, {
       "aria-label": title,
       className: cx(bc, className, (_cx = {}, _defineProperty(_cx, "".concat(bc, "--stacked-").concat(position, "-of-").concat(depth), // Don't apply this on the initial open of a single tearsheet.
       depth > 1 || depth === 1 && prevDepth.current > 1), _defineProperty(_cx, "".concat(bc, "--wide"), size === 'wide'), _defineProperty(_cx, "".concat(bc, "--narrow"), size !== 'wide'), _cx)),
@@ -237,7 +256,7 @@ export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     })))), /*#__PURE__*/React.createElement("div", {
       className: "".concat(bc, "__resize-detector"),
       ref: resizer
-    }));
+    })), portalTarget);
   } else {
     pconsole.warn('Tearsheet not rendered: maximum stacking depth exceeded.');
     return null;
@@ -377,6 +396,11 @@ TearsheetShell.propTypes = _objectSpread({
    */
   open: PropTypes.bool,
 
+  /**
+   * portal target for the all tags modal
+   */
+  portalTarget: PropTypes.node,
+
   /**
    * Specifies the width of the tearsheet, 'narrow' or 'wide'.
    */

package/es/components/UserProfileImage/UserProfileImage.js

@@ -1,6 +1,6 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["backgroundColor", "className", "kind", "initials", "image", "imageDescription", "size", "theme", "tooltipText"];
+var _excluded = ["backgroundColor", "className", "kind", "icon", "initials", "image", "imageDescription", "size", "theme", "tooltipText"];
 
 /**
  * Copyright IBM Corp. 2021, 2021
@@ -31,6 +31,7 @@ export var UserProfileImage = /*#__PURE__*/React.forwardRef(function (_ref, ref)
   var backgroundColor = _ref.backgroundColor,
       className = _ref.className,
       kind = _ref.kind,
+      icon = _ref.icon,
       initials = _ref.initials,
       image = _ref.image,
       imageDescription = _ref.imageDescription,
@@ -62,18 +63,40 @@ export var UserProfileImage = /*#__PURE__*/React.forwardRef(function (_ref, ref)
     return initials.match(/(^\S\S?|\b\S)?/g).join('').match(/(^\S|\S$)?/g).join('').toUpperCase();
   };
 
-  var FillItem = image ? function () {
-    return /*#__PURE__*/React.createElement("img", {
-      alt: imageDescription,
-      src: image,
-      className: "".concat(blockClass, "__photo ").concat(blockClass, "__photo--").concat(size)
-    });
-  } : initials ? formatInitials : kind && size && icons[kind][size];
+  var getFillItem = function getFillItem() {
+    if (image) {
+      return function () {
+        return /*#__PURE__*/React.createElement("img", {
+          alt: imageDescription,
+          src: image,
+          className: "".concat(blockClass, "__photo ").concat(blockClass, "__photo--").concat(size)
+        });
+      };
+    }
+
+    if (initials) {
+      return formatInitials;
+    }
+
+    if (kind && size) {
+      return icons[kind][size];
+    }
+
+    return icon;
+  }; // if user doesn't provide a color just generate a random one
+
+
+  var getRandomColor = function getRandomColor() {
+    var colors = ['light-cyan', 'dark-cyan', 'light-gray', 'dark-gray', 'light-green', 'dark-green', 'light-magenta', 'dark-magenta', 'light-purple', 'dark-purple', 'light-teal', 'dark-teal'];
+    return colors[Math.floor(Math.random() * colors.length)];
+  };
+
+  var FillItem = getFillItem();
 
   var renderUserProfileImage = function renderUserProfileImage() {
     return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
       ref: ref,
-      className: cx([blockClass, className, "".concat(blockClass, "--").concat(size), "".concat(blockClass, "--").concat(theme), "".concat(blockClass, "--").concat(backgroundColor)])
+      className: cx([blockClass, className, "".concat(blockClass, "--").concat(size), "".concat(blockClass, "--").concat(theme), "".concat(blockClass, "--").concat(backgroundColor || getRandomColor())])
     }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(FillItem, null));
   };
 
@@ -97,6 +120,11 @@ UserProfileImage.propTypes = {
    */
   className: PropTypes.string,
 
+  /**
+   * Provide a custom icon to use if you need to use an icon other than the included ones
+   */
+  icon: PropTypes.object,
+
   /**
    * When passing the image prop, supply a full path to the image to be displayed.
    */

package/es/components/index.js

@@ -36,4 +36,5 @@ export { WebTerminal } from './WebTerminal';
 export { EditSidePanel } from './EditSidePanel';
 export { OptionsTile } from './OptionsTile';
 export { InlineEdit } from './InlineEdit';
-export { DataSpreadsheet } from './DataSpreadsheet';
+export { DataSpreadsheet } from './DataSpreadsheet';
+export { Datagrid } from './Datagrid';

package/es/global/js/package-settings.js

@@ -63,13 +63,15 @@ var defaults = {
     EditSidePanel: false,
     CancelableTextEdit: false,
     InlineEdit: false,
-    DataSpreadsheet: false
+    DataSpreadsheet: false,
+    Datagrid: false
     /* new component flags here - comment used by generate CLI */
 
   },
   // feature level flags
   feature: {
-    'a-new-feature': false
+    'a-new-feature': false,
+    'default-portal-target-body': true
   }
 };
 

package/lib/components/ActionBar/ActionBar.js

@@ -93,6 +93,8 @@ var ActionBar = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
       className: "".concat(blockClass, "__hidden-sizing-items"),
       "aria-hidden": true,
       ref: sizingRef
+    }, /*#__PURE__*/_react.default.createElement("span", {
+      "aria-hidden": false
     }, /*#__PURE__*/_react.default.createElement(_ActionBarOverflowItems.ActionBarOverflowItems, {
       className: "".concat(blockClass, "__hidden-sizing-item"),
       overflowAriaLabel: "hidden sizing overflow items",
@@ -108,7 +110,7 @@ var ActionBar = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
         key: "hidden-item-".concat(key),
         className: "".concat(blockClass, "__hidden-sizing-item")
       }));
-    })));
+    }))));
   }, [actions]); // creates displayed items based on actions, displayCount and alignment
 
   (0, _react.useEffect)(function () {

package/lib/components/ActionBar/ActionBarOverflowItems.js

@@ -49,8 +49,10 @@ var ActionBarOverflowItems = function ActionBarOverflowItems(_ref) {
     className: (0, _classnames.default)(blockClass, className),
     direction: "bottom",
     flipped: true,
+    iconDescription: overflowAriaLabel // also needs setting to avoid a11y "Accessible name does not match or contain the visible label text"
+    ,
     menuOptionsClass: (0, _classnames.default)("".concat(blockClass, "__options"), menuOptionsClass)
-  }, _react.default.Children.map(overflowItems, function (item) {
+  }, _react.default.Children.map(overflowItems, function (item, index) {
     // This uses a copy of a menu item option
     // NOTE: Cannot use a real Tooltip icon below as it uses a <button /> the
     // div equivalent below is based on Carbon 10.25.0
@@ -58,10 +60,10 @@ var ActionBarOverflowItems = function ActionBarOverflowItems(_ref) {
       className: "".concat(blockClass, "__item"),
       itemText: /*#__PURE__*/_react.default.createElement("div", {
         className: "".concat(blockClass, "__item-content"),
-        "aria-describedby": "".concat(internalId, "--item-label")
+        "aria-describedby": "".concat(internalId.current, "-").concat(index, "--item-label")
       }, /*#__PURE__*/_react.default.createElement("span", {
         className: "".concat(blockClass, "__item-label"),
-        id: "".concat(internalId, "--item-label")
+        id: "".concat(internalId.current, "-").concat(index, "--item-label")
       }, item.props.iconDescription), /*#__PURE__*/_react.default.createElement(item.props.renderIcon, null))
     });
   }));