@carbon/ibm-products 2.0.0-rc.20 → 2.0.0-rc.21

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

@@ -1,12 +1,7 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 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, 2023
  *
@@ -17,18 +12,17 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 /* eslint-disable react/jsx-key */
 import React, { useRef, useMemo, useContext, useState, useEffect } from 'react';
 import PropTypes from 'prop-types';
-import { Accordion, AccordionItem, Button, Search, Checkbox, DatePicker, DatePickerInput, Dropdown, FormGroup, NumberInput, RadioButton, RadioButtonGroup, Layer } from '@carbon/react';
+import { Accordion, AccordionItem, Button, Search, Layer } from '@carbon/react';
 import { rem } from '@carbon/layout';
 import { pkg } from '../../../../../settings';
-import { BATCH, CHECKBOX, CLEAR_FILTERS, DATE, DROPDOWN, INSTANT, NUMBER, PANEL, RADIO } from './constants';
+import { BATCH, CLEAR_FILTERS, INSTANT, PANEL } from './constants';
 import cx from 'classnames';
 import { motion } from 'framer-motion';
 import { panelVariants, innerContainerVariants, actionSetVariants } from './motion/variants';
 import { Close } from '@carbon/react/icons';
 import { ActionSet } from '../../../../ActionSet';
 import { FilterContext } from '.';
-import { useInitialStateFromFilters, useSubscribeToEventEmitter, useShouldDisableButtons } from './hooks';
-import { getInitialStateFromFilters } from './utils';
+import { useFilters, useSubscribeToEventEmitter, useShouldDisableButtons } from './hooks';
 var blockClass = "".concat(pkg.prefix, "--datagrid");
 var componentClass = "".concat(blockClass, "-filter-panel");
 var MotionActionSet = motion(ActionSet);
@@ -66,30 +60,31 @@ var FilterPanel = function FilterPanel(_ref) {
       searchPlaceholder = _ref$searchPlaceholde === void 0 ? 'Find filters' : _ref$searchPlaceholde;
 
   /** State */
-  var _useInitialStateFromF = useInitialStateFromFilters(filterSections, PANEL),
-      _useInitialStateFromF2 = _slicedToArray(_useInitialStateFromF, 2),
-      filtersState = _useInitialStateFromF2[0],
-      setFiltersState = _useInitialStateFromF2[1];
-
-  var _useState = useState([]),
+  var _useState = useState(false),
       _useState2 = _slicedToArray(_useState, 2),
-      filtersObjectArray = _useState2[0],
-      setFiltersObjectArray = _useState2[1];
-
-  var _useState3 = useState(false),
-      _useState4 = _slicedToArray(_useState3, 2),
-      showDividerLine = _useState4[0],
-      setShowDividerLine = _useState4[1];
+      showDividerLine = _useState2[0],
+      setShowDividerLine = _useState2[1];
+
+  var _useFilters = useFilters({
+    updateMethod: updateMethod,
+    filters: filterSections,
+    setAllFilters: setAllFilters,
+    variation: PANEL
+  }),
+      filtersState = _useFilters.filtersState,
+      prevFiltersObjectArrayRef = _useFilters.prevFiltersObjectArrayRef,
+      prevFiltersRef = _useFilters.prevFiltersRef,
+      revertToPreviousFilters = _useFilters.revertToPreviousFilters,
+      reset = _useFilters.reset,
+      renderFilter = _useFilters.renderFilter,
+      filtersObjectArray = _useFilters.filtersObjectArray;
   /** Refs */
 
 
   var filterPanelRef = useRef();
   var filterHeadingRef = useRef();
   var filterSearchRef = useRef();
-  var actionSetRef = useRef(); // When using batch actions we have to store the filters to then apply them later
-
-  var prevFiltersRef = useRef(JSON.stringify(filtersState));
-  var prevFiltersObjectArrayRef = useRef(JSON.stringify(filtersObjectArray));
+  var actionSetRef = useRef();
   /** State from hooks */
 
   var _useShouldDisableButt = useShouldDisableButtons({
@@ -109,20 +104,13 @@ var FilterPanel = function FilterPanel(_ref) {
   /** Context */
 
   var _useContext = useContext(FilterContext),
-      leftPanelOpen = _useContext.leftPanelOpen,
-      setLeftPanelOpen = _useContext.setLeftPanelOpen;
+      panelOpen = _useContext.panelOpen,
+      setPanelOpen = _useContext.setPanelOpen;
   /** Methods */
 
 
   var closePanel = function closePanel() {
-    return setLeftPanelOpen(false);
-  }; // If the user decides to cancel or click outside the flyout, it reverts back to the filters that were
-  // there when they opened the flyout
-
-
-  var revertToPreviousFilters = function revertToPreviousFilters() {
-    setFiltersState(JSON.parse(prevFiltersRef.current));
-    setFiltersObjectArray(JSON.parse(prevFiltersObjectArrayRef.current));
+    return setPanelOpen(false);
   };
 
   var cancel = function cancel() {
@@ -133,19 +121,6 @@ var FilterPanel = function FilterPanel(_ref) {
     }
   };
 
-  var reset = function reset() {
-    // Get the initial values for the filters
-    var initialFiltersState = getInitialStateFromFilters(filterSections, PANEL);
-    var initialFiltersObjectArray = []; // Set the state to the initial values
-
-    setFiltersState(initialFiltersState);
-    setFiltersObjectArray(initialFiltersObjectArray);
-    setAllFilters([]); // Update their respective refs so everything is in sync
-
-    prevFiltersRef.current = JSON.stringify(initialFiltersState);
-    prevFiltersObjectArrayRef.current = JSON.stringify(initialFiltersObjectArray);
-  };
-
   var apply = function apply() {
     setAllFilters(filtersObjectArray); // From the user
 
@@ -157,225 +132,6 @@ var FilterPanel = function FilterPanel(_ref) {
     prevFiltersObjectArrayRef.current = JSON.stringify(filtersObjectArray);
   };
 
-  var applyFilters = function applyFilters(_ref2) {
-    var column = _ref2.column,
-        value = _ref2.value,
-        type = _ref2.type;
-
-    // If no end date is selected return because we need the end date to do computations
-    if (type === DATE && value.length > 0 && !value[1]) {
-      return;
-    }
-
-    var filtersObjectArrayCopy = _toConsumableArray(filtersObjectArray); // // check if the filter already exists in the array
-
-
-    var filter = filtersObjectArrayCopy.find(function (item) {
-      return item.id === column;
-    }); // // if filter exists in array then update the filter's new value
-
-    if (filter) {
-      filter.value = value;
-    } else {
-      filtersObjectArrayCopy.push({
-        id: column,
-        value: value,
-        type: type
-      });
-    } // ATTENTION: this is where you would reset or remove individual filters from the filters array
-
-
-    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 === DATE) {
-      if (value.length === 0) {
-        /**
-        Checks to see if the date value is an empty array, if it is that means the user wants
-        to reset the date filter
-        */
-        var _index = filtersObjectArrayCopy.findIndex(function (filter) {
-          return filter.id === column;
-        }); // Remove it from the filters array since there is nothing to filter
-
-
-        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 _index2 = filtersObjectArrayCopy.findIndex(function (filter) {
-          return filter.id === column;
-        }); // Remove it from the filters array
-
-
-        filtersObjectArrayCopy.splice(_index2, 1);
-      }
-    }
-
-    setFiltersObjectArray(filtersObjectArrayCopy); // // Automatically apply the filters if the updateMethod is instant
-
-    if (updateMethod === INSTANT) {
-      setAllFilters(filtersObjectArrayCopy);
-    }
-  };
-  /** Render the individual filter component */
-
-
-  var renderFilter = function renderFilter(_ref3) {
-    var _filtersState$column, _filtersState$column2, _filtersState$column3, _filtersState$column4;
-
-    var type = _ref3.type,
-        column = _ref3.column,
-        components = _ref3.props;
-
-    switch (type) {
-      case DATE:
-        return /*#__PURE__*/React.createElement(Layer, null, /*#__PURE__*/React.createElement(DatePicker, _extends({}, components.DatePicker, {
-          onChange: function onChange(value) {
-            var _components$DatePicke, _components$DatePicke2;
-
-            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
-              value: value,
-              type: type
-            })));
-            applyFilters({
-              column: column,
-              value: value,
-              type: type
-            });
-            (_components$DatePicke = (_components$DatePicke2 = components.DatePicker).onChange) === null || _components$DatePicke === void 0 ? void 0 : _components$DatePicke.call(_components$DatePicke2, value);
-          },
-          value: filtersState[column].value,
-          datePickerType: "range"
-        }), /*#__PURE__*/React.createElement(DatePickerInput, _extends({
-          placeholder: "mm/dd/yyyy",
-          labelText: "Start date"
-        }, components.DatePickerInput.start)), /*#__PURE__*/React.createElement(DatePickerInput, _extends({
-          placeholder: "mm/dd/yyyy",
-          labelText: "End date"
-        }, components.DatePickerInput.end))));
-
-      case NUMBER:
-        return /*#__PURE__*/React.createElement(Layer, null, /*#__PURE__*/React.createElement(NumberInput, _extends({
-          step: 1,
-          allowEmpty: true,
-          hideSteppers: true
-        }, components.NumberInput, {
-          onChange: function onChange(event) {
-            var _components$NumberInp, _components$NumberInp2;
-
-            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
-              value: event.target.value,
-              type: type
-            })));
-            applyFilters({
-              column: column,
-              value: event.target.value,
-              type: type
-            });
-            (_components$NumberInp = (_components$NumberInp2 = components.NumberInput).onChange) === null || _components$NumberInp === void 0 ? void 0 : _components$NumberInp.call(_components$NumberInp2, event);
-          },
-          value: filtersState[column].value
-        })));
-
-      case CHECKBOX:
-        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 isSelected = _ref4.checked;
-              var checkboxCopy = filtersState[column].value;
-              var foundCheckbox = checkboxCopy.find(function (checkbox) {
-                return checkbox.value === option.value;
-              });
-              foundCheckbox.selected = isSelected;
-              setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, {
-                value: checkboxCopy,
-                type: type
-              })));
-              applyFilters({
-                column: column,
-                value: _toConsumableArray(filtersState[column].value),
-                type: type
-              });
-              (_option$onChange = option.onChange) === null || _option$onChange === void 0 ? void 0 : _option$onChange.call(option, isSelected);
-            },
-            checked: option.selected
-          }));
-        }));
-
-      case RADIO:
-        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, {
-              value: selected,
-              type: type
-            })));
-            applyFilters({
-              column: column,
-              value: selected,
-              type: type
-            });
-            (_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;
-
-          return /*#__PURE__*/React.createElement(RadioButton, _extends({
-            key: (_ref5 = (_radio$id = radio.id) !== null && _radio$id !== void 0 ? _radio$id : radio.labelText) !== null && _ref5 !== void 0 ? _ref5 : radio.value
-          }, radio));
-        })));
-
-      case DROPDOWN:
-        return /*#__PURE__*/React.createElement(Layer, null, /*#__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, {
-              value: selectedItem,
-              type: type
-            })));
-            applyFilters({
-              column: column,
-              value: selectedItem,
-              type: type
-            });
-            (_components$Dropdown$ = (_components$Dropdown = components.Dropdown).onChange) === null || _components$Dropdown$ === void 0 ? void 0 : _components$Dropdown$.call(_components$Dropdown, selectedItem);
-          }
-        })));
-    }
-  };
-
   var renderActionSet = function renderActionSet() {
     return showActionSet && /*#__PURE__*/React.createElement(MotionActionSet, {
       actions: [{
@@ -408,12 +164,12 @@ var FilterPanel = function FilterPanel(_ref) {
 
 
   useEffect(function liftOpenStateToParent() {
-    if (leftPanelOpen) {
-      onPanelOpen(leftPanelOpen);
+    if (panelOpen) {
+      onPanelOpen(panelOpen);
     } else {
-      onPanelClose(leftPanelOpen);
+      onPanelClose(panelOpen);
     }
-  }, [leftPanelOpen, onPanelClose, onPanelOpen]);
+  }, [panelOpen, onPanelClose, onPanelOpen]);
   useEffect(function setPanelMinimumHeight() {
     var _filterPanelRef$curre;
 
@@ -433,9 +189,9 @@ var FilterPanel = function FilterPanel(_ref) {
 
   return /*#__PURE__*/React.createElement(motion.div, {
     ref: filterPanelRef,
-    className: cx(componentClass, "".concat(componentClass, "__container"), (_cx = {}, _defineProperty(_cx, "".concat(componentClass, "--open"), leftPanelOpen), _defineProperty(_cx, "".concat(componentClass, "--batch"), showActionSet), _defineProperty(_cx, "".concat(componentClass, "--instant"), !showActionSet), _cx)),
+    className: cx(componentClass, "".concat(componentClass, "__container"), (_cx = {}, _defineProperty(_cx, "".concat(componentClass, "--open"), panelOpen), _defineProperty(_cx, "".concat(componentClass, "--batch"), showActionSet), _defineProperty(_cx, "".concat(componentClass, "--instant"), !showActionSet), _cx)),
     initial: false,
-    animate: leftPanelOpen ? 'visible' : 'hidden',
+    animate: panelOpen ? 'visible' : 'hidden',
     variants: panelVariants
   }, /*#__PURE__*/React.createElement(motion.div, {
     variants: innerContainerVariants
@@ -469,25 +225,25 @@ var FilterPanel = function FilterPanel(_ref) {
       height: getScrollableContainerHeight()
     },
     onScroll: onInnerContainerScroll
-  }, filterSections.map(function (_ref7) {
-    var _ref7$categoryTitle = _ref7.categoryTitle,
-        categoryTitle = _ref7$categoryTitle === void 0 ? null : _ref7$categoryTitle,
-        _ref7$filters = _ref7.filters,
-        filters = _ref7$filters === void 0 ? [] : _ref7$filters,
-        hasAccordion = _ref7.hasAccordion;
+  }, filterSections.map(function (_ref2) {
+    var _ref2$categoryTitle = _ref2.categoryTitle,
+        categoryTitle = _ref2$categoryTitle === void 0 ? null : _ref2$categoryTitle,
+        _ref2$filters = _ref2.filters,
+        filters = _ref2$filters === void 0 ? [] : _ref2$filters,
+        hasAccordion = _ref2.hasAccordion;
     return /*#__PURE__*/React.createElement("div", {
       className: "".concat(componentClass, "__category")
     }, categoryTitle && /*#__PURE__*/React.createElement("div", {
       className: "".concat(componentClass, "__category-title")
-    }, categoryTitle), hasAccordion ? /*#__PURE__*/React.createElement(Accordion, null, filters.map(function (_ref8) {
-      var filterLabel = _ref8.filterLabel,
-          filter = _ref8.filter;
+    }, categoryTitle), hasAccordion ? /*#__PURE__*/React.createElement(Accordion, null, filters.map(function (_ref3) {
+      var filterLabel = _ref3.filterLabel,
+          filter = _ref3.filter;
       return /*#__PURE__*/React.createElement(AccordionItem, {
         title: filterLabel,
         key: filterLabel
       }, renderFilter(filter));
-    })) : filters.map(function (_ref9) {
-      var filter = _ref9.filter;
+    })) : filters.map(function (_ref4) {
+      var filter = _ref4.filter;
       return renderFilter(filter);
     }));
   })), renderActionSet()));

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

@@ -72,14 +72,14 @@ export var FilterProvider = function FilterProvider(_ref2) {
 
   var _useState = useState(false),
       _useState2 = _slicedToArray(_useState, 2),
-      leftPanelOpen = _useState2[0],
-      setLeftPanelOpen = _useState2[1];
+      panelOpen = _useState2[0],
+      setPanelOpen = _useState2[1];
 
   var value = {
     filterTags: filterTags,
     EventEmitter: EventEmitter,
-    leftPanelOpen: leftPanelOpen,
-    setLeftPanelOpen: setLeftPanelOpen
+    panelOpen: panelOpen,
+    setPanelOpen: setPanelOpen
   };
   return /*#__PURE__*/React.createElement(FilterContext.Provider, {
     value: value

package/es/components/Datagrid/Datagrid/addons/Filtering/hooks/index.js

@@ -6,4 +6,5 @@
  */
 export { default as useInitialStateFromFilters } from './useInitialStateFromFilters';
 export { default as useSubscribeToEventEmitter } from './useSubscribeToEventEmitter';
+export { default as useFilters } from './useFilters';
 export { default as useShouldDisableButtons } from './useShouldDisableButtons';