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

package/es/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js

@@ -1,336 +0,0 @@
-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", "id"],
-  _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, 2023
-//
-// 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 { useResizeObserver } from '../../global/js/hooks/useResizeObserver';
-
-// Carbon and package components we use.
-import { Breadcrumb, BreadcrumbItem, IconButton, Link, OverflowMenu, OverflowMenuItem, usePrefix } from '@carbon/react';
-import { pkg } from '../../settings';
-import { ArrowLeft, OverflowMenuHorizontal } from '@carbon/react/icons';
-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 carbonPrefix = usePrefix();
-  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, {
-      "aria-label": overflowAriaLabel,
-      iconDescription: overflowAriaLabel // also needs setting to avoid a11y "Accessible name does not match or contain the visible label text"
-      ,
-      renderIcon: function renderIcon(props) {
-        return /*#__PURE__*/React.createElement(OverflowMenuHorizontal, _extends({
-          size: 32
-        }, props));
-      },
-      className: "".concat(blockClass, "__overflow-menu"),
-      menuOptionsClass: "".concat(blockClass, "__overflow-menu-options")
-    },
-    // 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, {
-      "aria-label": overflowAriaLabel,
-      renderIcon: function renderIcon(props) {
-        return /*#__PURE__*/React.createElement(OverflowMenuHorizontal, _extends({
-          size: 32
-        }, props));
-      }
-    })), breadcrumbs.map(function (_ref3) {
-      var label = _ref3.label,
-        key = _ref3.key,
-        title = _ref3.title,
-        id = _ref3.id,
-        rest = _objectWithoutProperties(_ref3, _excluded2);
-      return /*#__PURE__*/React.createElement(BreadcrumbItem, _extends({
-        key: key
-      }, rest, {
-        // ensure id is not duplicated
-        "data-original-id": id,
-        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(carbonPrefix, "--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();
-  };
-  var backItem = breadcrumbs[breadcrumbs.length - 1];
-  /* istanbul ignore if */ // not sure how to test media queries
-  if (backItem.isCurrentPage) {
-    backItem = breadcrumbs[breadcrumbs.length - 2];
-  }
-
-  // container resize
-  useResizeObserver(sizingContainerRef, {
-    callback: handleResize
-  });
-  // item resize
-  useResizeObserver(breadcrumbItemWithOverflow, {
-    callback: handleResize
-  });
-  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, /*#__PURE__*/React.createElement(Breadcrumb, _extends({
-    className: cx("".concat(blockClass, "__breadcrumb-container"), _defineProperty({}, "".concat(blockClass, "__breadcrumb-container-with-items"), displayedBreadcrumbItems.length > 1)),
-    noTrailingSlash: noTrailingSlash
-  }, other), ((_backItem = backItem) === null || _backItem === void 0 ? void 0 : _backItem.href) && (((_backItem2 = backItem) === null || _backItem2 === void 0 ? void 0 : _backItem2.label) || ((_backItem3 = backItem) === null || _backItem3 === void 0 ? void 0 : _backItem3.title)) && /*#__PURE__*/React.createElement(BreadcrumbItem, {
-    className: cx("".concat(blockClass, "__breadcrumb-back"))
-  }, /*#__PURE__*/React.createElement(Link, {
-    href: backItem.href,
-    renderIcon: function renderIcon() {
-      return /*#__PURE__*/React.createElement(IconButton, {
-        className: "".concat(blockClass, "__back__button"),
-        align: "right",
-        kind: "ghost",
-        label: backItem.title || backItem.label,
-        size: "sm"
-      }, /*#__PURE__*/React.createElement(ArrowLeft, {
-        size: 16
-      }));
-    }
-  })), 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 breadcrumb items that do not fit.
-   */
-  overflowAriaLabel: PropTypes.string.isRequired.if(function (_ref6) {
-    var breadcrumbs = _ref6.breadcrumbs;
-    return breadcrumbs.length > 1;
-  })
-};
-BreadcrumbWithOverflow.displayName = componentName;

package/es/components/BreadcrumbWithOverflow/index.js

@@ -1,10 +0,0 @@
-//
-// 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';

package/es/components/ButtonMenu/ButtonMenu.js

@@ -1,129 +0,0 @@
-import _extends from "@babel/runtime/helpers/extends";
-import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["children", "className", "iconDescription", "kind", "label", "menuAriaLabel", "menuOptionsClass", "renderIcon", "size"];
-/**
- * Copyright IBM Corp. 2021, 2023
- *
- * 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';
-
-// Carbon and package components we use.
-import { Button, OverflowMenu, usePrefix } from '@carbon/react';
-
-// The block part of our conventional BEM class names (blockClass__E--M).
-var blockClass = "".concat(pkg.prefix, "--button-menu");
-var componentName = 'ButtonMenu';
-
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
-
-// Default values for props
-var defaults = {
-  size: 'lg',
-  kind: 'primary'
-};
-
-/**
- * Combining a standard button with an overflow menu, this component appears
- * as a button and has all the usual carbon Button props and rendering, but
- * acts as an overflow menu when clicked. The ButtonMenu component can contain
- * zero to many ButtonMenuItem, which is identical to the carbon
- * OverflowMenuItem component.
- */
-export var ButtonMenu = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
-  var children = _ref.children,
-    className = _ref.className,
-    iconDescription = _ref.iconDescription,
-    _ref$kind = _ref.kind,
-    kind = _ref$kind === void 0 ? defaults.kind : _ref$kind,
-    label = _ref.label,
-    menuAriaLabel = _ref.menuAriaLabel,
-    menuOptionsClass = _ref.menuOptionsClass,
-    Icon = _ref.renderIcon,
-    _ref$size = _ref.size,
-    size = _ref$size === void 0 ? defaults.size : _ref$size,
-    rest = _objectWithoutProperties(_ref, _excluded);
-  var carbonPrefix = usePrefix();
-  return /*#__PURE__*/React.createElement(OverflowMenu, _extends({}, rest, {
-    className: cx(blockClass,
-    // Apply the block class to the main HTML element
-    className // Apply any supplied class names to the main HTML element.
-    ),
-
-    "aria-label": menuAriaLabel,
-    menuOptionsClass: cx("".concat(blockClass, "__options"), menuOptionsClass),
-    size: size,
-    renderIcon: function renderIcon() {
-      return /*#__PURE__*/React.createElement("div", {
-        className: cx(["".concat(blockClass, "__trigger"), "".concat(carbonPrefix, "--btn"), "".concat(carbonPrefix, "--btn--").concat(kind), "".concat(carbonPrefix, "--btn--").concat(size)])
-      }, label, Icon && /*#__PURE__*/React.createElement(Icon, {
-        "aria-hidden": "true",
-        "aria-label": iconDescription,
-        className: "".concat(carbonPrefix, "--btn__icon")
-      }));
-    },
-    innerRef: ref
-  }), children);
-});
-
-// Return a placeholder if not released and not enabled by feature flag
-ButtonMenu = pkg.checkComponentEnabled(ButtonMenu, componentName);
-
-// The display name of the component, used by React. Note that displayName
-// is used in preference to relying on function.name.
-ButtonMenu.displayName = componentName;
-
-// The types and DocGen commentary for the component props,
-// in alphabetical order (for consistency).
-// See https://www.npmjs.com/package/prop-types#usage.
-ButtonMenu.propTypes = {
-  /**
-   * Provide the contents of the ButtonMenu. This should be one or more
-   * ButtonMenuItem components.
-   */
-  children: PropTypes.arrayOf(PropTypes.element).isRequired,
-  /**
-   * Provide an optional class to be applied to the containing node.
-   */
-  className: PropTypes.string,
-  /**
-   * If specifying the `renderIcon` prop, provide a description for that icon that can
-   * be read by screen readers
-   */
-  iconDescription: Button.propTypes.iconDescription,
-  /**
-   * The three types the menu button supports: primary, tertiary and ghost.
-   */
-  kind: PropTypes.oneOf(['primary', 'tertiary', 'ghost']),
-  /**
-   * The button label for the menu trigger.
-   */
-  label: PropTypes.node,
-  /**
-   * Provide the ariaLabel prop to be passed to the OverflowMenu. This is distinctly
-   * separate from `label` to support icon only ButtonMenus
-   */
-  menuAriaLabel: PropTypes.string.isRequired,
-  /**
-   * class name applied to the overflow options
-   */
-  menuOptionsClass: PropTypes.string,
-  /**
-   * Optional prop to allow overriding the icon rendering.
-   * Can be a React component class
-   */
-  renderIcon: Button.propTypes.renderIcon,
-  /**
-   * The size of the button for the menu trigger.
-   * The menu button supports: sm, md, lg
-   */
-  size: PropTypes.oneOf(['sm', 'md', 'lg'])
-};

package/es/components/ButtonMenu/ButtonMenuItem.js

@@ -1,33 +0,0 @@
-import _extends from "@babel/runtime/helpers/extends";
-/**
- * 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 { pkg } from '../../settings';
-
-// Carbon and package components we use.
-import { OverflowMenuItem } from '@carbon/react';
-var componentName = 'ButtonMenuItem';
-
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
-
-/**
- * A menu item to include in a button menu component. This component has the
- * same props and behaviors as carbon OverflowMenuItem.
- */
-export var ButtonMenuItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
-  return /*#__PURE__*/React.createElement(OverflowMenuItem, _extends({}, props, {
-    ref: ref
-  }));
-});
-
-// Return a placeholder if not released and not enabled by feature flag
-ButtonMenuItem = pkg.checkComponentEnabled(ButtonMenuItem, componentName);
-ButtonMenuItem.propTypes = OverflowMenuItem.propTypes;

package/es/components/ButtonMenu/index.js

@@ -1,9 +0,0 @@
-/**
- * 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 { ButtonMenu } from './ButtonMenu';
-export { ButtonMenuItem } from './ButtonMenuItem';