@carbon/ibm-products 2.0.0-rc.18 → 2.0.0-rc.19

package/es/components/Datagrid/Datagrid/DatagridToolbar.js

@@ -7,16 +7,13 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
  * 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, { useEffect, useState, useContext } from 'react';
+import React, { useEffect, useState } from 'react';
 import { Add, OverflowMenuVertical } from '@carbon/react/icons';
 import { TableToolbar, TableBatchActions, TableBatchAction } from '@carbon/react';
 import { useResizeDetector } from 'react-resize-detector';
 import { ButtonMenu, ButtonMenuItem } from '../../ButtonMenu';
 import { pkg, carbon } from '../../../settings';
 import cx from 'classnames';
-import { FilterSummary } from '../../FilterSummary';
-import { FilterContext } from './addons/Filtering/FilterProvider';
-import { CLEAR_FILTERS } from './addons/Filtering/constants';
 var blockClass = "".concat(pkg.prefix, "--datagrid");
 
 var DatagridBatchActionsToolbar = function DatagridBatchActionsToolbar(datagridState, width, ref) {
@@ -144,29 +141,14 @@ var DatagridToolbar = function DatagridToolbar(datagridState) {
   var DatagridActions = datagridState.DatagridActions,
       DatagridBatchActions = datagridState.DatagridBatchActions,
       batchActions = datagridState.batchActions,
-      state = datagridState.state,
       rowSize = datagridState.rowSize;
-
-  var _useContext = useContext(FilterContext),
-      filterTags = _useContext.filterTags,
-      EventEmitter = _useContext.EventEmitter;
-
-  var renderFilterSummary = function renderFilterSummary() {
-    return state.filters.length > 0 && /*#__PURE__*/React.createElement(FilterSummary, {
-      filters: filterTags,
-      clearFilters: function clearFilters() {
-        return EventEmitter.dispatch(CLEAR_FILTERS);
-      }
-    });
-  };
-
   var getRowHeight = rowSize ? rowSize : 'lg';
   return batchActions && DatagridActions ? /*#__PURE__*/React.createElement("div", {
     ref: ref,
     className: cx("".concat(blockClass, "__table-toolbar"), "".concat(blockClass, "__table-toolbar--").concat(getRowHeight))
-  }, /*#__PURE__*/React.createElement(TableToolbar, null, DatagridActions && DatagridActions(datagridState), DatagridBatchActionsToolbar && DatagridBatchActionsToolbar(datagridState, width, ref)), renderFilterSummary()) : DatagridActions ? /*#__PURE__*/React.createElement("div", {
+  }, /*#__PURE__*/React.createElement(TableToolbar, null, DatagridActions && DatagridActions(datagridState), DatagridBatchActionsToolbar && DatagridBatchActionsToolbar(datagridState, width, ref))) : DatagridActions ? /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__table-toolbar")
-  }, /*#__PURE__*/React.createElement(TableToolbar, null, DatagridActions && DatagridActions(datagridState), DatagridBatchActions && DatagridBatchActions(datagridState)), renderFilterSummary()) : null;
+  }, /*#__PURE__*/React.createElement(TableToolbar, null, DatagridActions && DatagridActions(datagridState), DatagridBatchActions && DatagridBatchActions(datagridState))) : null;
 };
 
 export default DatagridToolbar;

package/es/components/Datagrid/Datagrid/addons/Filtering/FilterFlyout.js

@@ -9,26 +9,22 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 // @flow
 
-/*
- * Licensed Materials - Property of IBM
- * 5724-Q36
- * (c) Copyright IBM Corp. 2022
- * US Government Users Restricted Rights - Use, duplication or disclosure
- * restricted by GSA ADP Schedule Contract with IBM Corp.
+/**
+ * Copyright IBM Corp. 2022, 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 { Filter } from '@carbon/react/icons';
-import { Button, Checkbox, DatePicker, DatePickerInput, Dropdown, FormGroup, NumberInput, RadioButton, RadioButtonGroup } from '@carbon/react';
+import { Button, Checkbox, DatePicker, DatePickerInput, Dropdown, FormGroup, NumberInput, RadioButton, RadioButtonGroup, usePrefix } from '@carbon/react';
 import cx from 'classnames';
 import PropTypes from 'prop-types';
 import React, { useCallback, useRef, useState } from 'react';
-import { useEffect } from 'react';
-import { useContext } from 'react';
 import { useClickOutside } from '../../../../../global/js/hooks';
 import { pkg } from '../../../../../settings';
 import { ActionSet } from '../../../../ActionSet';
-import { BATCH, CHECKBOX, CLEAR_FILTERS, DATE, DROPDOWN, INSTANT, NUMBER, RADIO } from './constants';
-import { FilterContext } from './FilterProvider';
-import useInitialStateFromFilters from './hooks/useInitialStateFromFilters';
+import { BATCH, CHECKBOX, CLEAR_FILTERS, DATE, DROPDOWN, FLYOUT, INSTANT, NUMBER, RADIO } from './constants';
+import { useInitialStateFromFilters, useSubscribeToEventEmitter, useShouldDisableButtons } from './hooks';
 import { getInitialStateFromFilters } from './utils';
 var blockClass = "".concat(pkg.prefix, "--datagrid");
 var componentClass = "".concat(blockClass, "-filter-flyout");
@@ -56,20 +52,17 @@ var FilterFlyout = function FilterFlyout(_ref) {
       onCancel = _ref$onCancel === void 0 ? function () {} : _ref$onCancel,
       _ref$secondaryActionL = _ref.secondaryActionLabel,
       secondaryActionLabel = _ref$secondaryActionL === void 0 ? 'Cancel' : _ref$secondaryActionL,
-      setAllFilters = _ref.setAllFilters;
+      setAllFilters = _ref.setAllFilters,
+      _ref$data = _ref.data,
+      data = _ref$data === void 0 ? [] : _ref$data;
 
-  /** Context state and methods */
-  var _useContext = useContext(FilterContext),
-      EventEmitter = _useContext.EventEmitter;
   /** State */
-
-
   var _useState = useState(false),
       _useState2 = _slicedToArray(_useState, 2),
       open = _useState2[0],
       setOpen = _useState2[1];
 
-  var _useInitialStateFromF = useInitialStateFromFilters(filters),
+  var _useInitialStateFromF = useInitialStateFromFilters(filters, FLYOUT),
       _useInitialStateFromF2 = _slicedToArray(_useInitialStateFromF, 2),
       filtersState = _useInitialStateFromF2[0],
       setFiltersState = _useInitialStateFromF2[1];
@@ -85,9 +78,21 @@ var FilterFlyout = function FilterFlyout(_ref) {
 
   var prevFiltersRef = useRef(JSON.stringify(filtersState));
   var prevFiltersObjectArrayRef = useRef(JSON.stringify(filtersObjectArray));
+  /** State from hooks */
+
+  var _useShouldDisableButt = useShouldDisableButtons({
+    initialValue: true,
+    filtersState: filtersState,
+    prevFiltersRef: prevFiltersRef
+  }),
+      _useShouldDisableButt2 = _slicedToArray(_useShouldDisableButt, 2),
+      shouldDisableButtons = _useShouldDisableButt2[0],
+      setShouldDisableButtons = _useShouldDisableButt2[1];
   /** Memos */
 
+
   var showActionSet = updateMethod === BATCH;
+  var carbonPrefix = usePrefix();
   /** Methods */
 
   var openFlyout = function openFlyout() {
@@ -102,8 +107,11 @@ var FilterFlyout = function FilterFlyout(_ref) {
 
   var apply = function apply() {
     setAllFilters(filtersObjectArray);
-    closeFlyout();
-    onApply(); // updates the ref so next time the flyout opens we have records of the previous filters
+    closeFlyout(); // From the user
+
+    onApply(); // When the user clicks apply, the action set buttons should be disabled again
+
+    setShouldDisableButtons(true); // updates the ref so next time the flyout opens we have records of the previous filters
 
     prevFiltersRef.current = JSON.stringify(filtersState);
     prevFiltersObjectArrayRef.current = JSON.stringify(filtersObjectArray);
@@ -121,7 +129,7 @@ var FilterFlyout = function FilterFlyout(_ref) {
 
   var reset = function reset() {
     // Get the initial values for the filters
-    var initialFiltersState = getInitialStateFromFilters(filters);
+    var initialFiltersState = getInitialStateFromFilters(filters, FLYOUT);
     var initialFiltersObjectArray = []; // Set the state to the initial values
 
     setFiltersState(initialFiltersState);
@@ -166,6 +174,37 @@ var FilterFlyout = function FilterFlyout(_ref) {
       });
     }
 
+    if (type === CHECKBOX) {
+      /**
+      When all checkboxes of a group are all unselected the value still exists in the filtersObjectArray
+      This checks if all the checkboxes are selected = false and removes it from the array
+      */
+      var index = filtersObjectArrayCopy.findIndex(function (filter) {
+        return filter.id === column;
+      }); // If all the selected state is false remove from array
+
+      var shouldRemoveFromArray = filtersObjectArrayCopy[index].value.every(function (val) {
+        return val.selected === false;
+      });
+
+      if (shouldRemoveFromArray) {
+        filtersObjectArrayCopy.splice(index, 1);
+      }
+    } else if (type === DROPDOWN || type === RADIO) {
+      if (value === 'Any') {
+        /**
+        Checks to see if the selected value is 'Any', that means the user wants
+        to reset specific filter
+        */
+        var _index = filtersObjectArrayCopy.findIndex(function (filter) {
+          return filter.id === column;
+        }); // Remove it from the filters array
+
+
+        filtersObjectArrayCopy.splice(_index, 1);
+      }
+    }
+
     setFiltersObjectArray(filtersObjectArrayCopy); // Automatically apply the filters if the updateMethod is instant
 
     if (updateMethod === INSTANT) {
@@ -176,33 +215,31 @@ var FilterFlyout = function FilterFlyout(_ref) {
 
   useClickOutside(filterFlyoutRef, function (target) {
     var hasClickedOnDatePicker = target.closest('.flatpickr-calendar');
+    var hasClickedOnDropdown = target.className === "".concat(carbonPrefix, "--list-box__menu-item__option");
 
-    if (!open || hasClickedOnDatePicker) {
+    if (!open || hasClickedOnDatePicker || hasClickedOnDropdown) {
       return;
     }
 
     cancel();
   });
-  useEffect(function subscribeToEmitter() {
-    // This event is emitted from the DatagridToolbar component when clearFilters is clicked in FilterSummary
-    EventEmitter.subscribe(CLEAR_FILTERS, reset);
-  });
+  useSubscribeToEventEmitter(CLEAR_FILTERS, reset);
   /** Render the individual filter component */
 
-  var renderFilter = useCallback(function (_ref3) {
+  var renderFilter = function renderFilter(_ref3) {
     var type = _ref3.type,
         column = _ref3.column,
         components = _ref3.props;
-    var key = "".concat(type, "-").concat(column, "-").concat(Math.random());
 
     if (type === DATE) {
-      return /*#__PURE__*/React.createElement(DatePicker, _extends({
-        key: key
-      }, components.DatePicker, {
+      return /*#__PURE__*/React.createElement(DatePicker, _extends({}, components.DatePicker, {
         onChange: function onChange(value) {
           var _components$DatePicke, _components$DatePicke2;
 
-          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, value)));
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
+            value: value,
+            type: type
+          })));
           applyFilters({
             column: column,
             value: value,
@@ -210,7 +247,7 @@ var FilterFlyout = function FilterFlyout(_ref) {
           });
           (_components$DatePicke = (_components$DatePicke2 = components.DatePicker).onChange) === null || _components$DatePicke === void 0 ? void 0 : _components$DatePicke.call(_components$DatePicke2, value);
         },
-        value: filtersState[column],
+        value: filtersState[column].value,
         datePickerType: "range"
       }), /*#__PURE__*/React.createElement(DatePickerInput, _extends({
         placeholder: "mm/dd/yyyy",
@@ -221,7 +258,6 @@ var FilterFlyout = function FilterFlyout(_ref) {
       }, components.DatePickerInput.end)));
     } else if (type === NUMBER) {
       return /*#__PURE__*/React.createElement(NumberInput, _extends({
-        key: key,
         step: 1,
         allowEmpty: true,
         hideSteppers: true
@@ -229,7 +265,10 @@ var FilterFlyout = function FilterFlyout(_ref) {
         onChange: function onChange(event) {
           var _components$NumberInp, _components$NumberInp2;
 
-          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, event.target.value)));
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
+            value: event.target.value,
+            type: type
+          })));
           applyFilters({
             column: column,
             value: event.target.value,
@@ -237,44 +276,48 @@ var FilterFlyout = function FilterFlyout(_ref) {
           });
           (_components$NumberInp = (_components$NumberInp2 = components.NumberInput).onChange) === null || _components$NumberInp === void 0 ? void 0 : _components$NumberInp.call(_components$NumberInp2, event);
         },
-        value: filtersState[column]
+        value: filtersState[column].value
       }));
     } else if (type === CHECKBOX) {
-      return /*#__PURE__*/React.createElement(FormGroup, _extends({
-        key: key
-      }, components.FormGroup), filtersState[column].map(function (option) {
+      return /*#__PURE__*/React.createElement(FormGroup, components.FormGroup, filtersState[column].value.map(function (option) {
         return /*#__PURE__*/React.createElement(Checkbox, _extends({
           key: option.labelText
         }, option, {
           onChange: function onChange(_, _ref4) {
             var _option$onChange;
 
-            var checked = _ref4.checked;
-            var checkboxCopy = filtersState[column];
+            var isSelected = _ref4.checked;
+            var checkboxCopy = filtersState[column].value;
             var foundCheckbox = checkboxCopy.find(function (checkbox) {
               return checkbox.value === option.value;
             });
-            foundCheckbox.selected = checked;
-            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, checkboxCopy)));
+            foundCheckbox.selected = isSelected;
+            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
+              value: checkboxCopy,
+              type: type
+            })));
             applyFilters({
               column: column,
-              value: _toConsumableArray(filtersState[column]),
+              value: _toConsumableArray(filtersState[column].value),
               type: type
             });
-            (_option$onChange = option.onChange) === null || _option$onChange === void 0 ? void 0 : _option$onChange.call(option, checked);
+            (_option$onChange = option.onChange) === null || _option$onChange === void 0 ? void 0 : _option$onChange.call(option, isSelected);
           },
           checked: option.selected
         }));
       }));
     } else if (type === RADIO) {
-      return /*#__PURE__*/React.createElement(FormGroup, _extends({
-        key: key
-      }, components.FormGroup), /*#__PURE__*/React.createElement(RadioButtonGroup, _extends({}, components.RadioButtonGroup, {
-        valueSelected: filtersState[column],
+      var _filtersState$column, _filtersState$column2;
+
+      return /*#__PURE__*/React.createElement(FormGroup, components.FormGroup, /*#__PURE__*/React.createElement(RadioButtonGroup, _extends({}, components.RadioButtonGroup, {
+        valueSelected: ((_filtersState$column = filtersState[column]) === null || _filtersState$column === void 0 ? void 0 : _filtersState$column.value) === '' ? 'Any' : (_filtersState$column2 = filtersState[column]) === null || _filtersState$column2 === void 0 ? void 0 : _filtersState$column2.value,
         onChange: function onChange(selected) {
           var _components$RadioButt, _components$RadioButt2;
 
-          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, selected)));
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
+            value: selected,
+            type: type
+          })));
           applyFilters({
             column: column,
             value: selected,
@@ -282,6 +325,10 @@ var FilterFlyout = function FilterFlyout(_ref) {
           });
           (_components$RadioButt = (_components$RadioButt2 = components.RadioButtonGroup).onChange) === null || _components$RadioButt === void 0 ? void 0 : _components$RadioButt.call(_components$RadioButt2, selected);
         }
+      }), /*#__PURE__*/React.createElement(RadioButton, {
+        id: "any",
+        labelText: "Any",
+        value: "Any"
       }), components.RadioButton.map(function (radio) {
         var _ref5, _radio$id;
 
@@ -290,15 +337,19 @@ var FilterFlyout = function FilterFlyout(_ref) {
         }, radio));
       })));
     } else if (type === DROPDOWN) {
-      return /*#__PURE__*/React.createElement(Dropdown, _extends({
-        key: key
-      }, components.Dropdown, {
-        selectedItem: filtersState[column],
+      var _filtersState$column3, _filtersState$column4;
+
+      return /*#__PURE__*/React.createElement(Dropdown, _extends({}, components.Dropdown, {
+        selectedItem: ((_filtersState$column3 = filtersState[column]) === null || _filtersState$column3 === void 0 ? void 0 : _filtersState$column3.value) === '' ? 'Any' : (_filtersState$column4 = filtersState[column]) === null || _filtersState$column4 === void 0 ? void 0 : _filtersState$column4.value,
+        items: ['Any'].concat(_toConsumableArray(components.Dropdown.items)),
         onChange: function onChange(_ref6) {
           var _components$Dropdown$, _components$Dropdown;
 
           var selectedItem = _ref6.selectedItem;
-          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, selectedItem)));
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
+            value: selectedItem,
+            type: type
+          })));
           applyFilters({
             column: column,
             value: selectedItem,
@@ -308,9 +359,10 @@ var FilterFlyout = function FilterFlyout(_ref) {
         }
       }));
     }
-  }, [filtersState, applyFilters, setFiltersState]);
+  };
   /** Renders all filters */
 
+
   var renderFilters = function renderFilters() {
     return filters.map(renderFilter);
   };
@@ -322,13 +374,15 @@ var FilterFlyout = function FilterFlyout(_ref) {
         kind: 'primary',
         label: primaryActionLabel,
         onClick: apply,
-        isExpressive: false
+        isExpressive: false,
+        disabled: shouldDisableButtons
       }, {
         key: 3,
         kind: 'secondary',
         label: secondaryActionLabel,
         onClick: cancel,
-        isExpressive: false
+        isExpressive: false,
+        disabled: shouldDisableButtons
       }],
       size: "md",
       buttonSize: "md"
@@ -348,7 +402,8 @@ var FilterFlyout = function FilterFlyout(_ref) {
     },
     iconDescription: flyoutIconDescription,
     onClick: open ? closeFlyout : openFlyout,
-    className: cx("".concat(componentClass, "__trigger"), _defineProperty({}, "".concat(componentClass, "__trigger--open"), open))
+    className: cx("".concat(componentClass, "__trigger"), _defineProperty({}, "".concat(componentClass, "__trigger--open"), open)),
+    disabled: data.length === 0
   }), /*#__PURE__*/React.createElement("div", {
     ref: filterFlyoutRef,
     className: cx(componentClass, (_cx2 = {}, _defineProperty(_cx2, "".concat(componentClass, "--open"), open), _defineProperty(_cx2, "".concat(componentClass, "--batch"), showActionSet), _defineProperty(_cx2, "".concat(componentClass, "--instant"), !showActionSet), _cx2))
@@ -362,6 +417,11 @@ var FilterFlyout = function FilterFlyout(_ref) {
 };
 
 FilterFlyout.propTypes = {
+  /**
+   * All data rows in the table
+   */
+  data: PropTypes.array.isRequired,
+
   /**
    * Array of filters to render
    */