@carbon/ibm-products 1.0.0-rc.0 → 1.0.1

package/es/components/ActionSet/ActionSet.js

@@ -0,0 +1,195 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "disabled", "kind", "label", "loading", "onClick", "size"],
+    _excluded2 = ["actions", "buttonSize", "className", "size"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+/**
+ * Copyright IBM Corp. 2021, 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.
+import React from 'react'; // Other standard imports.
+
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { pkg } from '../../settings';
+import { allPropTypes } from '../../global/js/utils/props-helper'; // Carbon and package components we use.
+
+import { Button, ButtonSet, InlineLoading } from 'carbon-components-react';
+var blockClass = "".concat(pkg.prefix, "--action-set");
+var componentName = 'ActionSet'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+var ActionSetButton = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+      disabled = _ref.disabled,
+      kind = _ref.kind,
+      label = _ref.label,
+      loading = _ref.loading,
+      onClick = _ref.onClick,
+      size = _ref.size,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  return /*#__PURE__*/React.createElement(Button, _extends({}, rest, {
+    isExpressive: true,
+    className: cx(className, ["".concat(blockClass, "__action-button"), _defineProperty({}, "".concat(blockClass, "__action-button--ghost"), kind === 'ghost')]),
+    disabled: disabled || loading || false,
+    kind: kind,
+    onClick: onClick,
+    ref: ref,
+    size: size
+  }), label, loading && /*#__PURE__*/React.createElement(InlineLoading, null));
+});
+ActionSetButton.displayName = 'ActionSetButton';
+ActionSetButton.propTypes = _objectSpread(_objectSpread({}, Button.PropTypes), {}, {
+  kind: PropTypes.oneOf(['ghost', 'secondary', 'primary']),
+  label: PropTypes.string,
+  loading: PropTypes.bool
+});
+var defaultKind = Button.defaultProps.kind;
+
+var willStack = function willStack(size, numberOfActions) {
+  return size === 'xs' || size === 'sm' || size === 'md' && numberOfActions > 2;
+};
+/**
+ * An ActionSet presents a set of action buttons, constructed from bundles
+ * of prop values and applying some layout rules. When the size is 'xs' or 'sm'
+ * the buttons are stacked, and should only include primary and secondary
+ * kinds. When the size is 'md' the buttons are stacked if there are three or
+ * more. When the size is 'md' or 'lg', two buttons share the horizontal space.
+ * When the size is 'lg', three or more buttons use a quarter of the available
+ * horizontal space, and if the size is 'xlg' or 'max' the buttons always use
+ * a quarter of the available horizontal space. If there is a ghost button,
+ * it appears at the left side. If there is a primary button it appears at the
+ * right.
+ */
+
+
+export var ActionSet = /*#__PURE__*/React.forwardRef(function (_ref3, ref) {
+  var _actions$slice, _cx;
+
+  var actions = _ref3.actions,
+      buttonSize = _ref3.buttonSize,
+      className = _ref3.className,
+      size = _ref3.size,
+      rest = _objectWithoutProperties(_ref3, _excluded2);
+
+  var buttons = actions && ((_actions$slice = actions.slice) === null || _actions$slice === void 0 ? void 0 : _actions$slice.call(actions, 0)) || []; // We stack the buttons in a xs/sm set, or if there are three or more in a md set.
+
+  var stacking = willStack(size, buttons.length); // order the actions with ghost buttons first and primary buttons last
+  // (and the opposite way if we're stacking)
+
+  buttons.sort(function (action1, action2) {
+    var kind1 = action1.kind || defaultKind;
+    var kind2 = action2.kind || defaultKind;
+    return kind1 === 'ghost' || kind2 === 'primary' ? stacking ? 1 : -1 : kind1 === 'primary' || kind2 === 'ghost' ? stacking ? -1 : 1 : 0;
+  });
+  return /*#__PURE__*/React.createElement(ButtonSet, _extends({}, rest, {
+    className: cx(blockClass, className, (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "--row-single"), !stacking && buttons.length === 1), _defineProperty(_cx, "".concat(blockClass, "--row-double"), !stacking && buttons.length === 2), _defineProperty(_cx, "".concat(blockClass, "--row-triple"), !stacking && buttons.length === 3), _defineProperty(_cx, "".concat(blockClass, "--row-quadruple"), !stacking && buttons.length >= 4), _defineProperty(_cx, "".concat(blockClass, "--stacking"), stacking), _cx), "".concat(blockClass, "--").concat(size)),
+    ref: ref,
+    role: "presentation",
+    stacked: stacking
+  }), buttons.map(function (action, index) {
+    return /*#__PURE__*/React.createElement(ActionSetButton, _extends({
+      key: action.key || index
+    }, action, {
+      size: buttonSize
+    }));
+  }));
+});
+ActionSet.displayName = componentName;
+/**
+ * A validator function to help validate the actions supplied for a particular
+ * size of component. When the size is xs or sm, or md with three actions, the
+ * buttons will be stacked and a maximum of three buttons is applied with no
+ * ghosts unless the ghost is the only button. Otherwise a maximum of four
+ * buttons with a maximum of one ghost is applied. In either case, a maximum
+ * of one primary button is allowed.
+ * @param sizeFn An optional function which will be passed all the props and
+ * returns the size that the component should be treated as being: if not
+ * provided, a 'size' prop is used to determine the size of the component.
+ * @returns null if the actions meet the requirements, or an Error object with
+ * an explanatory message.
+ */
+
+ActionSet.validateActions = function (sizeFn) {
+  return function (props, propName, componentName, location, propFullName) {
+    var name = propFullName || propName;
+    var prop = props[name];
+    var actions = prop && (prop === null || prop === void 0 ? void 0 : prop.length);
+    var problems = [];
+
+    if (actions > 0) {
+      var size = sizeFn ? sizeFn(props) : props.size;
+      var stacking = willStack(size, actions);
+
+      var countActions = function countActions(kind) {
+        return prop.filter(function (action) {
+          return (action.kind || defaultKind) === kind;
+        }).length;
+      };
+
+      var primaryActions = countActions('primary');
+      var secondaryActions = countActions('secondary');
+      var ghostActions = countActions('ghost');
+      stacking && actions > 3 && problems.push("you cannot have more than three actions in this size of ".concat(componentName));
+      actions > 4 && problems.push("you cannot have more than four actions in a ".concat(componentName));
+      primaryActions > 1 && problems.push("you cannot have more than one 'primary' action in a ".concat(componentName));
+      ghostActions > 1 && problems.push("you cannot have more than one 'ghost' action in a ".concat(componentName));
+      stacking && actions > 1 && ghostActions > 0 && problems.push("you cannot have a 'ghost' button in conjunction with other action types in this size of ".concat(componentName));
+      actions > primaryActions + secondaryActions + ghostActions && problems.push("you can only have 'primary', 'secondary' and 'ghost' buttons in a ".concat(componentName));
+    }
+
+    return problems.length > 0 ? new Error("Invalid ".concat(location, " `").concat(name, "` supplied to `").concat(componentName, "`: ").concat(problems.join(', and '), ".")) : null;
+  };
+};
+
+ActionSet.propTypes = {
+  /**
+   * The action buttons to show. Each action is specified as an
+   * object with optional fields 'label' to supply the button label, 'kind'
+   * to select the button kind (must be 'primary', 'secondary' or 'ghost'),
+   * 'loading' to display a loading indicator, and 'onClick' to receive
+   * notifications when the button is clicked. Additional fields in the object
+   * will be passed to the Button component, and these can include 'disabled',
+   * 'ref', 'className', and any other Button props. Any other fields in the
+   * object will be passed through to the button element as HTML attributes.
+   *
+   * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+   */
+  actions: allPropTypes([ActionSet.validateActions(), PropTypes.arrayOf(PropTypes.shape(_objectSpread(_objectSpread({}, Button.propTypes), {}, {
+    kind: PropTypes.oneOf(['ghost', 'secondary', 'primary']),
+    label: PropTypes.string,
+    loading: PropTypes.bool,
+    // we duplicate this Button prop to improve the DocGen here
+    onClick: Button.propTypes.onClick
+  })))]),
+
+  /**
+   * The size of buttons to use for the actions. The allowed values are
+   * those for the size prop of carbon Button. If this prop is specified, all
+   * the buttons will be set to this size, overriding any 'size' values (if any)
+   * supplied in the actions array (if any).
+   */
+  buttonSize: Button.propTypes.size,
+
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: PropTypes.string,
+
+  /**
+   * The size of the action set. Different button arrangements are used at
+   * different sizes, to make best use of the available space.
+   */
+  size: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xlg', 'max'])
+};
+ActionSet.defaultProps = {
+  size: 'md'
+};

package/es/components/ActionSet/actions.js

@@ -0,0 +1,48 @@
+/**
+ * Copyright IBM Corp. 2021, 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.
+ */
+export var actionsOptions = [0, 1, 2, 3, 4, 5, 6, 7];
+export var actionsLabels = {
+  0: 'None',
+  1: 'One button',
+  2: 'One ghost button',
+  3: 'Two buttons',
+  4: 'Two buttons including one ghost',
+  5: 'Three buttons',
+  6: 'Three buttons including one ghost',
+  7: 'Four buttons including one ghost'
+};
+export var actionsMapping = function actionsMapping(labels, action) {
+  var _labels$primary, _labels$secondary, _labels$secondary2, _labels$ghost;
+
+  var act = function act(label, kind, key) {
+    var actionCall = action && action("Click on '".concat(label, "'"));
+    return {
+      label: label,
+      kind: kind,
+      key: key,
+      onClick: actionCall && function (evt) {
+        evt && evt.persist();
+        actionCall(evt);
+      }
+    };
+  };
+
+  var primary = act((_labels$primary = labels === null || labels === void 0 ? void 0 : labels.primary) !== null && _labels$primary !== void 0 ? _labels$primary : 'Primary', 'primary', 1);
+  var secondary = act((_labels$secondary = labels === null || labels === void 0 ? void 0 : labels.secondary) !== null && _labels$secondary !== void 0 ? _labels$secondary : 'Secondary', 'secondary', 2);
+  var secondary2 = act((_labels$secondary2 = labels === null || labels === void 0 ? void 0 : labels.secondary2) !== null && _labels$secondary2 !== void 0 ? _labels$secondary2 : 'Secondary', 'secondary', 3);
+  var ghost = act((_labels$ghost = labels === null || labels === void 0 ? void 0 : labels.ghost) !== null && _labels$ghost !== void 0 ? _labels$ghost : 'Ghost', 'ghost', 4);
+  return {
+    0: [],
+    1: [primary],
+    2: [ghost],
+    3: [primary, secondary],
+    4: [primary, ghost],
+    5: [primary, secondary, secondary2],
+    6: [primary, secondary, ghost],
+    7: [primary, secondary, secondary2, ghost]
+  };
+};

package/es/components/ActionSet/index.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright IBM Corp. 2021, 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.
+ */
+export { ActionSet } from './ActionSet';

package/es/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js

@@ -0,0 +1,349 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["breadcrumbs", "className", "maxVisible", "noTrailingSlash", "overflowAriaLabel"],
+    _excluded2 = ["label", "key", "title"],
+    _excluded3 = ["className", "key", "label", "title"];
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+//
+// 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.
+import React, { useState, useEffect, useRef } from 'react'; // Other standard imports.
+
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Button } from 'carbon-components-react';
+import { pkg, carbon } from '../../settings';
+import { useResizeDetector } from 'react-resize-detector';
+import { ArrowLeft16 } from '@carbon/icons-react'; // Carbon and package components we use.
+
+import { Breadcrumb, BreadcrumbItem, OverflowMenu, OverflowMenuItem } from 'carbon-components-react';
+import { OverflowMenuHorizontal32 } from '@carbon/icons-react';
+import uuidv4 from '../../global/js/utils/uuidv4';
+import '../../global/js/utils/props-helper'; // The block part of our conventional BEM class names (blockClass__E--M).
+
+var blockClass = "".concat(pkg.prefix, "--breadcrumb-with-overflow");
+var componentName = 'BreadcrumbWithOverflow'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+/**
+ * The BreadcrumbWithOverflow is used internally by the PageHeader to wrap BreadcrumbItems.
+ */
+
+export var BreadcrumbWithOverflow = function BreadcrumbWithOverflow(_ref) {
+  var _backItem, _backItem2, _backItem3;
+
+  var breadcrumbs = _ref.breadcrumbs,
+      className = _ref.className,
+      maxVisible = _ref.maxVisible,
+      noTrailingSlash = _ref.noTrailingSlash,
+      overflowAriaLabel = _ref.overflowAriaLabel,
+      other = _objectWithoutProperties(_ref, _excluded);
+
+  var _useState = useState(3),
+      _useState2 = _slicedToArray(_useState, 2),
+      displayCount = _useState2[0],
+      setDisplayCount = _useState2[1];
+
+  var _useState3 = useState([]),
+      _useState4 = _slicedToArray(_useState3, 2),
+      displayedBreadcrumbItems = _useState4[0],
+      setDisplayedBreadcrumbItems = _useState4[1];
+
+  var breadcrumbItemWithOverflow = useRef(null);
+  var sizingContainerRef = useRef(null);
+  var internalId = useRef(uuidv4());
+
+  var _useState5 = useState([]),
+      _useState6 = _slicedToArray(_useState5, 2),
+      hiddenSizingItems = _useState6[0],
+      setHiddenSizingItems = _useState6[1]; // eslint-disable-next-line react/prop-types
+
+
+  var BreadcrumbOverflowMenu = function BreadcrumbOverflowMenu(_ref2) {
+    var overflowItems = _ref2.overflowItems;
+    return /*#__PURE__*/React.createElement(BreadcrumbItem, {
+      key: "breadcrumb-overflow-".concat(internalId.current)
+    }, /*#__PURE__*/React.createElement(OverflowMenu, {
+      ariaLabel: overflowAriaLabel,
+      renderIcon: OverflowMenuHorizontal32,
+      className: "".concat(blockClass, "__overflow-menu")
+    }, // eslint-disable-next-line react/prop-types
+    overflowItems.map(function (item, index) {
+      return /*#__PURE__*/React.createElement(OverflowMenuItem, {
+        key: "breadcrumb-overflow-menu-item-".concat(internalId.current, "-").concat(index),
+        href: item.props.href,
+        onClick: item.props.onClick,
+        itemText: item.props.children
+      });
+    })));
+  }; // create hidden sizing items
+
+
+  useEffect(function () {
+    // Hidden action bar and items used to calculate sizes
+    setHiddenSizingItems( /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__breadcrumb-container ").concat(blockClass, "__breadcrumb-container--hidden"),
+      "aria-hidden": true,
+      ref: sizingContainerRef
+    }, /*#__PURE__*/React.createElement(Breadcrumb, null, /*#__PURE__*/React.createElement(BreadcrumbItem, {
+      key: "".concat(blockClass, "-hidden-overflow-").concat(internalId)
+    }, /*#__PURE__*/React.createElement(OverflowMenu, {
+      ariaLabel: overflowAriaLabel,
+      renderIcon: OverflowMenuHorizontal32
+    })), breadcrumbs.map(function (_ref3) {
+      var label = _ref3.label,
+          key = _ref3.key,
+          title = _ref3.title,
+          rest = _objectWithoutProperties(_ref3, _excluded2);
+
+      return /*#__PURE__*/React.createElement(BreadcrumbItem, _extends({
+        key: key
+      }, rest, {
+        title: title !== null && title !== void 0 ? title : label
+      }), label);
+    }))));
+  }, [breadcrumbs, overflowAriaLabel]);
+  useEffect(function () {
+    // updates displayedBreadcrumbItems and overflowBreadcrumbItems based on displayCount and breadcrumbs
+
+    /* istanbul ignore if */
+    if (breadcrumbs.length === 0) {
+      setDisplayedBreadcrumbItems([]);
+      return;
+    }
+
+    var newDisplayedBreadcrumbItems = breadcrumbs.map(function (_ref4, index) {
+      var className = _ref4.className,
+          key = _ref4.key,
+          label = _ref4.label,
+          title = _ref4.title,
+          rest = _objectWithoutProperties(_ref4, _excluded3);
+
+      return /*#__PURE__*/React.createElement(BreadcrumbItem, _extends({
+        key: key,
+        className: index > 0 || displayCount > 1 ? cx([className, "".concat(blockClass, "__displayed-breadcrumb")]) : className,
+        title: index + 1 === breadcrumbs.length ? title : null
+      }, rest), label);
+    }); // The breadcrumb has the form [first item] [overflow] [items 2...(n-1)] [last item].
+    // The overflow is only shown if there isn't space to display all the items, and in that case:
+    //  * the last item is always displayed (even if there isn't really space for it -- it can contract to an ellipsis);
+    //  * the first item is the next to be displayed, if there's space once the last item and overflow are shown;
+    //  * any remaining space after the first item, last item and overflow are shown is used to show items (n-1), (n-2), (n-3), ..., until the space is used up ;
+    // Note that displayCount (min 1) has been computed based on the available space and the above sequence.
+
+    var overflowPosition = displayCount > 1 ? 1 : 0;
+    var newOverflowBreadcrumbItems = newDisplayedBreadcrumbItems.splice(overflowPosition, breadcrumbs.length - displayCount); // if needed add overflow menu
+
+    if (newOverflowBreadcrumbItems.length) {
+      newDisplayedBreadcrumbItems.splice(overflowPosition, 0, /*#__PURE__*/React.createElement(BreadcrumbOverflowMenu, {
+        overflowItems: newOverflowBreadcrumbItems,
+        key: "displayed-breadcrumb-".concat(internalId, "-overflow")
+      }));
+    }
+
+    setDisplayedBreadcrumbItems(newDisplayedBreadcrumbItems);
+  }, [breadcrumbs, displayCount]);
+
+  var checkFullyVisibleBreadcrumbItems = function checkFullyVisibleBreadcrumbItems() {
+    var displayItemIndex = function displayItemIndex(itemCount, index) {
+      // In this data set the overflow measuring item is [0]
+      // so the first displayItem in the list is [1]
+      // we never return 0;
+      if (index === 0) {
+        return itemCount - 1; // the last item in the list
+      } else if (index === 1) {
+        return 1; // the first item in the list
+      } else {
+        return itemCount - index; // count down from itemCount - 2 to 1
+      }
+    };
+
+    if (maxVisible <= 1) {
+      setDisplayCount(1);
+    } else {
+      // how many will fit?
+      var willFit = 0;
+      var spaceAvailable = breadcrumbItemWithOverflow.current.offsetWidth; // not sure how to test resize
+
+      /* istanbul ignore next */
+
+      if (sizingContainerRef.current) {
+        var sizingBreadcrumbItems = sizingContainerRef.current.querySelectorAll(".".concat(carbon.prefix, "--breadcrumb-item"));
+        var breadcrumbWidthsIncludingMargin = [];
+
+        var _iterator = _createForOfIteratorHelper(sizingBreadcrumbItems),
+            _step;
+
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            var computedStyle = window ? window.getComputedStyle(sizingBreadcrumbItems[0]) : null;
+            var marginWidths = computedStyle ? parseFloat(computedStyle.marginLeft || 0, 10) + parseFloat(computedStyle.marginRight || 0, 10) : 0;
+            breadcrumbWidthsIncludingMargin.push(item.offsetWidth + marginWidths);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+
+        var overflowWidth = breadcrumbWidthsIncludingMargin[0];
+
+        for (var i = 0; i < breadcrumbWidthsIncludingMargin.length - 1; i++) {
+          // count used one less than length to account for the included overflow item
+          var index = displayItemIndex(breadcrumbWidthsIncludingMargin.length, i);
+
+          if (spaceAvailable >= breadcrumbWidthsIncludingMargin[index]) {
+            spaceAvailable -= breadcrumbWidthsIncludingMargin[index];
+            willFit += 1;
+          } else {
+            break;
+          }
+        } // if not enough space for all breadcrumb items
+
+
+        if (willFit < breadcrumbWidthsIncludingMargin.length - 1) {
+          // -1 for overflow item
+          while (willFit > 0 && spaceAvailable < overflowWidth) {
+            willFit -= 1; // Highly unlikely any useful breadcrumb-item is smaller than the overflow menu, but we loop anyway just in case
+            // item removed is based on last item added which is the current value of willFit
+
+            var itemToRemove = displayItemIndex(breadcrumbWidthsIncludingMargin.length, willFit);
+            spaceAvailable += breadcrumbWidthsIncludingMargin[itemToRemove];
+          }
+        }
+      }
+
+      if (willFit <= 1) {
+        setDisplayCount(1);
+      } else {
+        setDisplayCount(maxVisible ? Math.min(willFit, maxVisible) : willFit);
+      }
+    }
+  };
+
+  useEffect(function () {
+    checkFullyVisibleBreadcrumbItems(); // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [hiddenSizingItems, maxVisible]);
+  /* istanbul ignore next */
+  // not sure how to test resize
+
+  var handleResize = function handleResize() {
+    /* istanbul ignore next */
+    // not sure how to test resize
+    checkFullyVisibleBreadcrumbItems();
+  };
+  /* istanbul ignore next */
+  // not sure how to test resize
+
+
+  var handleBreadcrumbItemsResize = function handleBreadcrumbItemsResize() {
+    /* istanbul ignore next */
+    // not sure how to test resize
+    checkFullyVisibleBreadcrumbItems();
+  };
+
+  var backItem = breadcrumbs[breadcrumbs.length - 1];
+  /* istanbul ignore if */
+  // not sure how to test media queries
+
+  if ((_backItem = backItem) !== null && _backItem !== void 0 && _backItem.isCurrentPage) {
+    backItem = breadcrumbs[breadcrumbs.length - 2];
+  }
+
+  useResizeDetector({
+    onResize: handleBreadcrumbItemsResize,
+    targetRef: sizingContainerRef
+  });
+  useResizeDetector({
+    onResize: handleResize,
+    targetRef: breadcrumbItemWithOverflow
+  });
+  return /*#__PURE__*/React.createElement("div", {
+    className: cx(blockClass, className, _defineProperty({}, "".concat(blockClass, "__with-items"), displayedBreadcrumbItems.length > 1)),
+    ref: breadcrumbItemWithOverflow
+  }, /*#__PURE__*/React.createElement("div", {
+    className: cx(["".concat(blockClass, "__space")])
+  }, hiddenSizingItems, ((_backItem2 = backItem) === null || _backItem2 === void 0 ? void 0 : _backItem2.href) && ((_backItem3 = backItem) === null || _backItem3 === void 0 ? void 0 : _backItem3.title) && /*#__PURE__*/React.createElement(Button, {
+    className: "".concat(blockClass, "__breadcrumb-back-button"),
+    hasIconOnly: true,
+    iconDescription: backItem.title,
+    kind: "ghost",
+    href: backItem.href,
+    renderIcon: ArrowLeft16,
+    size: "field",
+    tooltipPosition: "right",
+    type: "button"
+  }), /*#__PURE__*/React.createElement(Breadcrumb, _extends({
+    className: cx("".concat(blockClass, "__breadcrumb-container"), _defineProperty({}, "".concat(blockClass, "__breadcrumb-container-with-items"), displayedBreadcrumbItems.length > 1)),
+    noTrailingSlash: noTrailingSlash
+  }, other), displayedBreadcrumbItems)));
+}; // Return a placeholder if not released and not enabled by feature flag
+
+BreadcrumbWithOverflow = pkg.checkComponentEnabled(BreadcrumbWithOverflow, componentName);
+BreadcrumbWithOverflow.propTypes = {
+  breadcrumbs: PropTypes.arrayOf(PropTypes.shape({
+    /**
+     * Optional string representing the link location for the BreadcrumbItem
+     */
+    href: PropTypes.string,
+
+    /**
+     * Provide if this breadcrumb item represents the current page
+     */
+    isCurrentPage: PropTypes.bool,
+
+    /**
+     * Key required to render array efficiently
+     */
+    key: PropTypes.string.isRequired,
+
+    /**
+     * Pass in content that will be inside of the BreadcrumbItem
+     */
+    label: PropTypes.node,
+
+    /**
+     * A string based alternative to the children, required only if children is not of type string.
+     */
+    title: PropTypes.string.isRequired.if(function (_ref5) {
+      var label = _ref5.label;
+      return typeof label !== 'string';
+    })
+  })),
+
+  /**
+   * className
+   */
+  className: PropTypes.string,
+
+  /**
+   * maxVisible: maximum visible breadcrumb-items before overflow is used (values less than 1 are treated as 1)
+   */
+  maxVisible: PropTypes.number,
+
+  /**
+   * noTrailing slash - same as for Carbon
+   */
+  noTrailingSlash: PropTypes.bool,
+
+  /**
+   * overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+   */
+  overflowAriaLabel: PropTypes.string.isRequired
+};
+BreadcrumbWithOverflow.defaultProps = {
+  noTrailingSlash: false
+};
+BreadcrumbWithOverflow.displayName = componentName;

package/es/components/BreadcrumbWithOverflow/index.js

@@ -0,0 +1,8 @@
+//
+// 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.
+//
+// NOTE: An index file is most useful when you have multiple components
+export { BreadcrumbWithOverflow } from './BreadcrumbWithOverflow';