@carbon/ibm-products 1.13.0 → 1.16.0

package/es/components/AddSelect/AddSelect.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 = ["className", "columnInputPlaceholder", "description", "influencerTitle", "inputPlaceholder", "items", "itemsLabel", "multi", "noResultsDescription", "noResultsTitle", "noSelectionDescription", "noSelectionTitle", "onClose", "onCloseButtonText", "onSearchFilter", "onSubmit", "onSubmitButtonText", "open", "removeIconDescription", "searchResultsLabel", "textInputLabel", "title"];
+var _excluded = ["className", "clearFiltersText", "columnInputPlaceholder", "description", "globalFilters", "globalFiltersIconDescription", "globalFiltersPlaceholderText", "globalFiltersPrimaryButtonText", "globalFiltersSecondaryButtonText", "globalSearchLabel", "globalSearchPlaceholder", "influencerTitle", "items", "itemsLabel", "multi", "noResultsDescription", "noResultsTitle", "noSelectionDescription", "noSelectionTitle", "onClose", "onCloseButtonText", "onSubmit", "onSubmitButtonText", "open", "portalTarget", "removeIconDescription", "searchResultsLabel", "title"];
 //
 // Copyright IBM Corp. 2022
 //
@@ -12,7 +12,7 @@ var _excluded = ["className", "columnInputPlaceholder", "description", "influenc
 import React, { forwardRef, useState, useEffect } from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
-import { TextInput, Tag } from 'carbon-components-react';
+import { Tag } from 'carbon-components-react';
 import { Tearsheet, TearsheetNarrow } from '../../components/Tearsheet';
 import { NoDataEmptyState } from '../../components/EmptyStates/NoDataEmptyState';
 import { pkg } from '../../settings';
@@ -20,16 +20,24 @@ import { AddSelectSidebar } from './AddSelectSidebar';
 import { AddSelectBreadcrumbs } from './AddSelectBreadcrumbs';
 import { AddSelectList } from './AddSelectList';
 import { AddSelectColumn } from './AddSelectColumn';
-import { normalize, flatten } from './add-select-utils';
+import { normalize, flatten, getGlobalFilterValues } from './add-select-utils';
+import { AddSelectFilter } from './AddSelectFilter';
 var componentName = 'AddSelect';
 export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _cx;
 
   var className = _ref.className,
+      clearFiltersText = _ref.clearFiltersText,
       columnInputPlaceholder = _ref.columnInputPlaceholder,
       description = _ref.description,
+      globalFilters = _ref.globalFilters,
+      globalFiltersIconDescription = _ref.globalFiltersIconDescription,
+      globalFiltersPlaceholderText = _ref.globalFiltersPlaceholderText,
+      globalFiltersPrimaryButtonText = _ref.globalFiltersPrimaryButtonText,
+      globalFiltersSecondaryButtonText = _ref.globalFiltersSecondaryButtonText,
+      globalSearchLabel = _ref.globalSearchLabel,
+      globalSearchPlaceholder = _ref.globalSearchPlaceholder,
       influencerTitle = _ref.influencerTitle,
-      inputPlaceholder = _ref.inputPlaceholder,
       items = _ref.items,
       itemsLabel = _ref.itemsLabel,
       multi = _ref.multi,
@@ -39,13 +47,12 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
       noSelectionTitle = _ref.noSelectionTitle,
       onClose = _ref.onClose,
       onCloseButtonText = _ref.onCloseButtonText,
-      onSearchFilter = _ref.onSearchFilter,
       onSubmit = _ref.onSubmit,
       onSubmitButtonText = _ref.onSubmitButtonText,
       open = _ref.open,
+      portalTarget = _ref.portalTarget,
       removeIconDescription = _ref.removeIconDescription,
       searchResultsLabel = _ref.searchResultsLabel,
-      textInputLabel = _ref.textInputLabel,
       title = _ref.title,
       rest = _objectWithoutProperties(_ref, _excluded);
 
@@ -86,19 +93,39 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
       flatItems = _useState14[0],
       setFlatItems = _useState14[1];
 
+  var _useState15 = useState([]),
+      _useState16 = _slicedToArray(_useState15, 2),
+      globalFilterOpts = _useState16[0],
+      setGlobalFilterOpts = _useState16[1];
+
+  var _useState17 = useState({}),
+      _useState18 = _slicedToArray(_useState17, 2),
+      appliedGlobalFilters = _useState18[0],
+      setAppliedGlobalFilters = _useState18[1];
+
   useEffect(function () {
     var entries = items.entries; // flatItems is just a single array of all entries including children
 
-    setFlatItems(flatten(entries)); // multi select with nested data needs to be normalized
+    var flattenedItems = flatten(entries);
+
+    if (multi) {
+      if (globalFilters !== null && globalFilters !== void 0 && globalFilters.length) {
+        var globalFilterValues = getGlobalFilterValues(globalFilters, flattenedItems);
+        setGlobalFilterOpts(globalFilterValues);
+      } // multi select with nested data needs to be normalized
+
 
-    if (multi && entries.find(function (entry) {
-      return entry.children;
-    })) {
-      var newItems = normalize(items);
-      setNormalizedItems(newItems);
-      setUsedNormalizedItems(true);
+      if (entries.find(function (entry) {
+        return entry.children;
+      })) {
+        var newItems = normalize(items);
+        setNormalizedItems(newItems);
+        setUsedNormalizedItems(true);
+      }
     }
-  }, [items, multi]); // used to generate columns of results for multi select with hierarchy
+
+    setFlatItems(flattenedItems);
+  }, [items, multi, globalFilters]); // used to generate columns of results for multi select with hierarchy
 
   var getPages = function getPages() {
     var pages = [];
@@ -157,11 +184,6 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
     var results = itemsToFilter.filter(function (item) {
       if (!searchTerm) {
         return item;
-      } // if user provides their own filter function use that
-
-
-      if (onSearchFilter) {
-        return onSearchFilter(item, searchTerm);
       } // otherwise use the default label filter
 
 
@@ -172,11 +194,18 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
 
   var getDisplayItems = function getDisplayItems() {
     if (useNormalizedItems) {
-      // when global search is in use the results are not in column format
-      if (searchTerm) {
-        return flatItems.filter(function (item) {
+      // when global search or filter is in use the results are not in column format
+      var filters = Object.keys(appliedGlobalFilters);
+
+      if (searchTerm || filters.length) {
+        var results = flatItems.filter(function (item) {
           return item.title.toLowerCase().includes(searchTerm);
+        }).filter(function (item) {
+          return filters.every(function (filter) {
+            return item[filter] === appliedGlobalFilters[filter];
+          });
         });
+        return results;
       }
 
       return getPages();
@@ -197,15 +226,21 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
     singleSelection: singleSelection
   }; // handlers
 
-  var handleSearch = function handleSearch(e) {
-    setSearchTerm(e.target.value);
+  var handleSearch = function handleSearch(term) {
+    setSearchTerm(term);
+  };
+
+  var handleFilter = function handleFilter(filters) {
+    setAppliedGlobalFilters(filters);
   };
 
   var submitHandler = function submitHandler() {
     onSubmit(multi ? multiSelection : singleSelection);
   };
 
+  var classNames = cx(className, blockClass, (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "__single"), !multi), _defineProperty(_cx, "".concat(blockClass, "__multi"), multi), _cx));
   var commonTearsheetProps = {
+    className: classNames,
     open: open,
     title: title,
     description: description,
@@ -219,7 +254,8 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
       kind: 'primary',
       onClick: submitHandler,
       disabled: multi ? multiSelection.length === 0 : !singleSelection
-    }]
+    }],
+    portalTarget: portalTarget
   };
   var sidebarProps = {
     influencerTitle: influencerTitle,
@@ -230,7 +266,6 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
     removeIconDescription: removeIconDescription,
     setMultiSelection: setMultiSelection
   };
-  var classNames = cx(className, blockClass, (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "__single"), !multi), _defineProperty(_cx, "".concat(blockClass, "__multi"), multi), _cx));
 
   var setShowBreadsCrumbs = function setShowBreadsCrumbs() {
     if (searchTerm) {
@@ -257,16 +292,26 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
   };
 
   var showBreadsCrumbs = setShowBreadsCrumbs();
-  var showTags = setShowTags(); // main content
+  var showTags = setShowTags();
+  var globalFiltersApplied = Object.keys(appliedGlobalFilters).length > 0; // main content
 
   var body = /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__header")
-  }, /*#__PURE__*/React.createElement(TextInput, {
-    id: "temp-id",
-    labelText: textInputLabel,
-    placeholder: inputPlaceholder,
-    value: searchTerm,
-    onChange: handleSearch
+  }, /*#__PURE__*/React.createElement(AddSelectFilter, {
+    inputLabel: globalSearchLabel,
+    inputPlaceholder: globalSearchPlaceholder,
+    searchTerm: searchTerm,
+    handleSearch: handleSearch,
+    multi: multi,
+    filterOpts: globalFilterOpts,
+    handleFilter: handleFilter,
+    primaryButtonText: globalFiltersPrimaryButtonText,
+    secondaryButtonText: globalFiltersSecondaryButtonText,
+    placeholder: globalFiltersPlaceholderText,
+    iconDescription: globalFiltersIconDescription,
+    appliedFilters: appliedGlobalFilters,
+    hasFiltersApplied: globalFiltersApplied,
+    clearFiltersText: clearFiltersText
   }), /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__tag-container")
   }, showBreadsCrumbs ? /*#__PURE__*/React.createElement(AddSelectBreadcrumbs, {
@@ -278,7 +323,7 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, searchTerm ? searchResultsLabel : itemsLabel), showTags && /*#__PURE__*/React.createElement(Tag, {
     type: "gray",
     size: "sm"
-  }, itemsToDisplay.length))), useNormalizedItems && !searchTerm ? /*#__PURE__*/React.createElement("div", {
+  }, itemsToDisplay.length))), useNormalizedItems && !searchTerm && !globalFiltersApplied ? /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__columns")
   }, itemsToDisplay.map(function (page, idx) {
     var _path;
@@ -299,8 +344,7 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
     title: noResultsTitle
   }))));
   return /*#__PURE__*/React.createElement("div", _extends({
-    ref: ref,
-    className: classNames
+    ref: ref
   }, rest), multi ? /*#__PURE__*/React.createElement(Tearsheet, _extends({}, commonTearsheetProps, {
     influencer: multi && /*#__PURE__*/React.createElement(AddSelectSidebar, sidebarProps),
     influencerPosition: "right"
@@ -308,23 +352,39 @@ export var AddSelect = /*#__PURE__*/forwardRef(function (_ref, ref) {
 });
 AddSelect.propTypes = {
   className: PropTypes.string,
+  clearFiltersText: PropTypes.string,
   columnInputPlaceholder: PropTypes.string,
   description: PropTypes.string,
+  globalFilters: PropTypes.arrayOf(PropTypes.shape({
+    id: PropTypes.string,
+    label: PropTypes.string
+  })),
+  globalFiltersIconDescription: PropTypes.string,
+  globalFiltersPlaceholderText: PropTypes.string,
+  globalFiltersPrimaryButtonText: PropTypes.string,
+  globalFiltersSecondaryButtonText: PropTypes.string,
+  globalSearchLabel: PropTypes.string,
+  globalSearchPlaceholder: PropTypes.string,
   influencerTitle: PropTypes.string,
-  inputPlaceholder: PropTypes.string,
   items: PropTypes.shape({
     modifiers: PropTypes.shape({
       label: PropTypes.string,
-      options: PropTypes.array,
-      property: 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,
-      children: PropTypes.object
+      value: PropTypes.string.isRequired
     }))
   }),
   itemsLabel: PropTypes.string,
@@ -335,13 +395,16 @@ AddSelect.propTypes = {
   noSelectionTitle: PropTypes.string,
   onClose: PropTypes.func,
   onCloseButtonText: PropTypes.string,
-  onSearchFilter: PropTypes.func,
   onSubmit: PropTypes.func,
   onSubmitButtonText: PropTypes.string,
   open: PropTypes.bool,
+
+  /**
+   * portal target for the all tags modal
+   */
+  portalTarget: PropTypes.node,
   removeIconDescription: PropTypes.string,
   searchResultsLabel: PropTypes.string,
-  textInputLabel: PropTypes.string,
   title: PropTypes.string
 };
 AddSelect.defaultProps = {

package/es/components/AddSelect/AddSelectFilter.js

@@ -0,0 +1,172 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+
+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) { _defineProperty(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; }
+
+//
+// Copyright IBM Corp. 2022
+//
+// 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 React, { useState } from 'react';
+import { Button, ButtonSet, Dropdown, TextInput, Tag } from 'carbon-components-react';
+import PropTypes from 'prop-types';
+import { Filter16 } from '@carbon/icons-react';
+import { pkg } from '../../settings';
+var componentName = 'AddSelectFilter';
+export var AddSelectFilter = function AddSelectFilter(_ref) {
+  var appliedFilters = _ref.appliedFilters,
+      clearFiltersText = _ref.clearFiltersText,
+      filterOpts = _ref.filterOpts,
+      handleFilter = _ref.handleFilter,
+      handleSearch = _ref.handleSearch,
+      hasFiltersApplied = _ref.hasFiltersApplied,
+      iconDescription = _ref.iconDescription,
+      inputLabel = _ref.inputLabel,
+      inputPlaceholder = _ref.inputPlaceholder,
+      multi = _ref.multi,
+      placeholder = _ref.placeholder,
+      primaryButtonText = _ref.primaryButtonText,
+      searchTerm = _ref.searchTerm,
+      secondaryButtonText = _ref.secondaryButtonText;
+
+  var _useState = useState({}),
+      _useState2 = _slicedToArray(_useState, 2),
+      filters = _useState2[0],
+      setFilters = _useState2[1];
+
+  var _useState3 = useState(false),
+      _useState4 = _slicedToArray(_useState3, 2),
+      open = _useState4[0],
+      setOpen = _useState4[1];
+
+  var blockClass = "".concat(pkg.prefix, "--add-select__global-filter");
+
+  var searchHandler = function searchHandler(e) {
+    handleSearch(e.target.value);
+  };
+
+  var onchangeHandler = function onchangeHandler(_ref2, id) {
+    var selectedItem = _ref2.selectedItem;
+    setFilters(_objectSpread(_objectSpread({}, filters), {}, _defineProperty({}, id, selectedItem)));
+  };
+  /**
+   * this component needs to manage it's own internal state of filters before they're applied
+   * setFilters manages the local filter state
+   * applyFilters adds the filter state to the parent
+   * resetFilters resets the local state
+   * clearFilters resets both
+   */
+
+
+  var applyFilters = function applyFilters() {
+    handleFilter(filters);
+  };
+
+  var resetFilters = function resetFilters() {
+    setFilters({});
+  };
+
+  var clearFilters = function clearFilters() {
+    resetFilters();
+    handleFilter({});
+  };
+
+  var removeTag = function removeTag(key) {
+    var newFilters = _objectSpread({}, filters);
+
+    delete newFilters[key];
+    setFilters(newFilters);
+    handleFilter(newFilters);
+  };
+
+  var getSelectedItem = function getSelectedItem(id) {
+    return filters[id] || '';
+  };
+
+  var showFilter = multi && (filterOpts === null || filterOpts === void 0 ? void 0 : filterOpts.length) > 0;
+  return /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "-search")
+  }, /*#__PURE__*/React.createElement(TextInput, {
+    id: "temp-id",
+    labelText: inputLabel,
+    placeholder: inputPlaceholder,
+    value: searchTerm,
+    onChange: searchHandler
+  }), showFilter && /*#__PURE__*/React.createElement(Button, {
+    renderIcon: Filter16,
+    hasIconOnly: true,
+    kind: "ghost",
+    onClick: function onClick() {
+      return setOpen(!open);
+    },
+    iconDescription: iconDescription,
+    className: "".concat(blockClass, "-toggle"),
+    size: "md"
+  }), open && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass)
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "-content")
+  }, /*#__PURE__*/React.createElement("p", null, "Filters"), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "-opts")
+  }, filterOpts.map(function (filterOpts) {
+    return /*#__PURE__*/React.createElement(Dropdown, {
+      id: filterOpts.id,
+      key: filterOpts.id,
+      titleText: filterOpts.label,
+      items: filterOpts.opts,
+      light: true,
+      onChange: function onChange(value) {
+        return onchangeHandler(value, filterOpts.id);
+      },
+      selectedItem: getSelectedItem(filterOpts.id),
+      label: placeholder
+    });
+  }))), /*#__PURE__*/React.createElement(ButtonSet, {
+    className: "".concat(blockClass, "-button-set")
+  }, /*#__PURE__*/React.createElement(Button, {
+    kind: "secondary",
+    onClick: resetFilters,
+    className: "".concat(blockClass, "-button")
+  }, secondaryButtonText), /*#__PURE__*/React.createElement(Button, {
+    kind: "primary",
+    onClick: applyFilters,
+    className: "".concat(blockClass, "-button")
+  }, primaryButtonText)))), hasFiltersApplied && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "-applied")
+  }, Object.keys(appliedFilters).map(function (filterType) {
+    return /*#__PURE__*/React.createElement(Tag, {
+      key: filterType,
+      type: "gray",
+      size: "sm",
+      onClose: function onClose() {
+        return removeTag(filterType);
+      },
+      filter: true
+    }, "".concat(filterType, ": ").concat(appliedFilters[filterType]));
+  }), /*#__PURE__*/React.createElement(Button, {
+    kind: "ghost",
+    size: "sm",
+    onClick: clearFilters
+  }, clearFiltersText)));
+};
+AddSelectFilter.propTypes = {
+  appliedFilters: PropTypes.object,
+  clearFiltersText: PropTypes.string,
+  filterOpts: PropTypes.array,
+  handleFilter: PropTypes.func,
+  handleSearch: PropTypes.func,
+  hasFiltersApplied: PropTypes.bool,
+  iconDescription: PropTypes.string,
+  inputLabel: PropTypes.string,
+  inputPlaceholder: PropTypes.string,
+  multi: PropTypes.bool,
+  placeholder: PropTypes.string,
+  primaryButtonText: PropTypes.string,
+  searchTerm: PropTypes.string,
+  secondaryButtonText: PropTypes.string
+};
+AddSelectFilter.displayName = componentName;

package/es/components/AddSelect/add-select-utils.js

@@ -61,4 +61,34 @@ export var flatten = function flatten(entries) {
 
     return prev.concat(item).concat(children ? flatten(children.entries) : []);
   }, []);
+};
+/**
+ * takes in a global filters array and a flat list of items
+ * it then searches through the items and finds any with the matching filter properties
+ * and adds those values to the array
+ * globalFilters looks like [{ id: someProperty }]
+ * the returned array would look like [{ id: someProperty, opts: [value, value]}]
+ * @param {Array} globalFilters - list of filter properties
+ * @param {Array} items - items to search through
+ * @returns an array of filter values
+ */
+
+export var getGlobalFilterValues = function getGlobalFilterValues(globalFilters, items) {
+  var filterOpts = globalFilters.reduce(function (prevFilter, curFilter) {
+    var filterId = curFilter.id;
+    var opts = items.reduce(function (prevItem, curItem) {
+      var value = curItem[filterId];
+
+      if (value && !prevItem.includes(value)) {
+        prevItem.push(value);
+      }
+
+      return prevItem;
+    }, []);
+    prevFilter.push(_objectSpread({
+      opts: opts
+    }, curFilter));
+    return prevFilter;
+  }, []);
+  return filterOpts;
 };