@helpscout/hsds-react/components/FilteredList/FilteredList.js

React component library for Help Scout's Design System

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

exports.__esModule = true;
exports.default = void 0;

var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));

var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));

var _react = _interopRequireWildcard(require("react"));

var _propTypes = _interopRequireDefault(require("prop-types"));

var _getValidProps = _interopRequireDefault(require("@helpscout/react-utils/dist/getValidProps"));

var _classnames = _interopRequireDefault(require("classnames"));

var _lodash = _interopRequireDefault(require("lodash.isstring"));

var _lodash2 = _interopRequireDefault(require("lodash.isplainobject"));

var _Text = _interopRequireDefault(require("../Text"));

var _Tooltip = _interopRequireDefault(require("../Tooltip"));

var _FilteredList = require("./FilteredList.css");

var _jsxRuntime = require("react/jsx-runtime");

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; }

var getItemValue = function getItemValue(item, itemKey) {
  if (!(0, _lodash.default)(item) && (0, _lodash2.default)(item) && itemKey) {
    return item[itemKey];
  }

  return item;
};

var FilteredListBadge = function FilteredListBadge(props) {
  var limit = props.limit,
      items = props.items,
      itemKey = props.itemKey,
      badgeProps = props.badgeProps;
  var renderBadgeContent = (0, _react.useCallback)(function () {
    return items.slice(limit, items.length).map(function (item) {
      var value = getItemValue(item, itemKey);
      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_FilteredList.BadgeItemUI, {
        "data-cy": "FilteredList.BadgeItem",
        "data-testid": "FilteredList.BadgeItem",
        children: value
      }, value);
    });
  }, [items, limit, itemKey]);
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Tooltip.default, {
    closeOnContentClick: true,
    renderContent: renderBadgeContent,
    withTriggerWrapper: false,
    children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_FilteredList.BadgeUI, (0, _extends2.default)({
      tabIndex: 0,
      isSquare: true,
      "data-cy": "FilteredList.Badge",
      "data-testid": "FilteredList.Badge"
    }, badgeProps, {
      children: ["+", items.length - limit]
    }))
  });
};

var FilteredList = function FilteredList(props) {
  var badgeProps = props.badgeProps,
      children = props.children,
      className = props.className,
      inline = props.inline,
      limit = props.limit,
      renderItem = props.renderItem,
      items = props.items,
      itemKey = props.itemKey,
      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["badgeProps", "children", "className", "inline", "limit", "renderItem", "items", "itemKey"]);
  var componentClassName = (0, _classnames.default)('c-FilteredList', inline && 'is-inline', className);

  var renderItems = function renderItems() {
    var itemsList = limit ? items.slice(0, limit) : items;
    var isListFiltered = limit && items.length > limit;
    return itemsList.map(function (item, index) {
      var isLastItem = index + 1 >= itemsList.length;
      var isBadgeVisible = isListFiltered && isLastItem;
      var isSeparatorVisible = !isLastItem && inline;
      var value = getItemValue(item, itemKey);
      return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_FilteredList.ItemUI, {
        "data-cy": "FilteredList.Item",
        "data-testid": "FilteredList.Item",
        children: [renderItem && renderItem(item), !renderItem && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
          "data-cy": "FilteredList.ItemLabel",
          children: value
        }), isBadgeVisible && /*#__PURE__*/(0, _jsxRuntime.jsx)(FilteredListBadge, {
          items: items,
          limit: limit,
          itemKey: itemKey,
          badgeProps: badgeProps
        }), isSeparatorVisible && /*#__PURE__*/(0, _jsxRuntime.jsx)(_FilteredList.SeparatorUI, {
          "data-cy": "FilteredList.Separator",
          "data-testid": "FilteredList.Separator",
          children: "\u2022"
        })]
      }, value);
    });
  };

  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_FilteredList.FilteredListUI, (0, _extends2.default)({
    "aria-label": "FilteredList"
  }, (0, _getValidProps.default)(rest), {
    className: componentClassName,
    children: renderItems()
  }));
};

FilteredList.defaultProps = {
  'data-cy': 'FilteredList',
  items: [],
  limit: 5
};
FilteredList.propTypes = {
  /** Extra props to the badge component */
  badgeProps: _propTypes.default.object,

  /** Key to pull the value from the object (optional) */
  itemKey: _propTypes.default.string,

  /** Custom class names to be added to the component. */
  className: _propTypes.default.string,

  /** List of items that need to be filtered */
  items: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object])),

  /** Number of items visible */
  limit: _propTypes.default.number,

  /** Display the item inline */
  inline: _propTypes.default.bool,
  renderItem: _propTypes.default.func,

  /** Data attr for Cypress tests. */
  'data-cy': _propTypes.default.string
};
var _default = FilteredList;
exports.default = _default;