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

package/lib/components/Datagrid/Datagrid/addons/Filtering/hooks/useFilters.js

@@ -0,0 +1,325 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _react2 = require("@carbon/react");
+
+var _constants = require("../constants");
+
+var _useInitialStateFromFilters = _interopRequireDefault(require("./useInitialStateFromFilters"));
+
+var _utils = require("../utils");
+
+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; }
+
+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) { (0, _defineProperty2.default)(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; }
+
+var useFilters = function useFilters(_ref) {
+  var updateMethod = _ref.updateMethod,
+      _ref$filters = _ref.filters,
+      filters = _ref$filters === void 0 ? [] : _ref$filters,
+      setAllFilters = _ref.setAllFilters,
+      variation = _ref.variation;
+
+  /** State */
+  var _useInitialStateFromF = (0, _useInitialStateFromFilters.default)(filters, variation),
+      _useInitialStateFromF2 = (0, _slicedToArray2.default)(_useInitialStateFromF, 2),
+      filtersState = _useInitialStateFromF2[0],
+      setFiltersState = _useInitialStateFromF2[1];
+
+  var _useState = (0, _react.useState)([]),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+      filtersObjectArray = _useState2[0],
+      setFiltersObjectArray = _useState2[1]; // When using batch actions we have to store the filters to then apply them later
+
+
+  var prevFiltersRef = (0, _react.useRef)(JSON.stringify(filtersState));
+  var prevFiltersObjectArrayRef = (0, _react.useRef)(JSON.stringify(filtersObjectArray));
+  /** Methods */
+  // 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));
+  };
+
+  var reset = function reset() {
+    // Get the initial values for the filters
+    var initialFiltersState = (0, _utils.getInitialStateFromFilters)(filters, variation);
+    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 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 === _constants.DATE && value.length > 0 && !value[1]) {
+      return;
+    }
+
+    var filtersObjectArrayCopy = (0, _toConsumableArray2.default)(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 === _constants.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 === _constants.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 === _constants.DROPDOWN || type === _constants.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 === _constants.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;
+    var isPanel = variation === _constants.PANEL;
+    var filter;
+
+    switch (type) {
+      case _constants.DATE:
+        filter = /*#__PURE__*/_react.default.createElement(_react2.DatePicker, (0, _extends2.default)({}, components.DatePicker, {
+          onChange: function onChange(value) {
+            var _components$DatePicke, _components$DatePicke2;
+
+            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, (0, _defineProperty2.default)({}, 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.default.createElement(_react2.DatePickerInput, (0, _extends2.default)({
+          placeholder: "mm/dd/yyyy",
+          labelText: "Start date"
+        }, components.DatePickerInput.start)), /*#__PURE__*/_react.default.createElement(_react2.DatePickerInput, (0, _extends2.default)({
+          placeholder: "mm/dd/yyyy",
+          labelText: "End date"
+        }, components.DatePickerInput.end)));
+        break;
+
+      case _constants.NUMBER:
+        filter = /*#__PURE__*/_react.default.createElement(_react2.NumberInput, (0, _extends2.default)({
+          step: 1,
+          allowEmpty: true,
+          hideSteppers: true
+        }, components.NumberInput, {
+          onChange: function onChange(event) {
+            var _components$NumberInp, _components$NumberInp2;
+
+            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, (0, _defineProperty2.default)({}, 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
+        }));
+        break;
+
+      case _constants.CHECKBOX:
+        filter = /*#__PURE__*/_react.default.createElement(_react2.FormGroup, components.FormGroup, filtersState[column].value.map(function (option) {
+          return /*#__PURE__*/_react.default.createElement(_react2.Checkbox, (0, _extends2.default)({
+            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), {}, (0, _defineProperty2.default)({}, column, {
+                value: checkboxCopy,
+                type: type
+              })));
+              applyFilters({
+                column: column,
+                value: (0, _toConsumableArray2.default)(filtersState[column].value),
+                type: type
+              });
+              (_option$onChange = option.onChange) === null || _option$onChange === void 0 ? void 0 : _option$onChange.call(option, isSelected);
+            },
+            checked: option.selected
+          }));
+        }));
+        break;
+
+      case _constants.RADIO:
+        filter = /*#__PURE__*/_react.default.createElement(_react2.FormGroup, components.FormGroup, /*#__PURE__*/_react.default.createElement(_react2.RadioButtonGroup, (0, _extends2.default)({}, 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), {}, (0, _defineProperty2.default)({}, 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.default.createElement(_react2.RadioButton, {
+          id: "any",
+          labelText: "Any",
+          value: "Any"
+        }), components.RadioButton.map(function (radio) {
+          var _ref5, _radio$id;
+
+          return /*#__PURE__*/_react.default.createElement(_react2.RadioButton, (0, _extends2.default)({
+            key: (_ref5 = (_radio$id = radio.id) !== null && _radio$id !== void 0 ? _radio$id : radio.labelText) !== null && _ref5 !== void 0 ? _ref5 : radio.value
+          }, radio));
+        })));
+        break;
+
+      case _constants.DROPDOWN:
+        filter = /*#__PURE__*/_react.default.createElement(_react2.Dropdown, (0, _extends2.default)({}, 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((0, _toConsumableArray2.default)(components.Dropdown.items)),
+          onChange: function onChange(_ref6) {
+            var _components$Dropdown$, _components$Dropdown;
+
+            var selectedItem = _ref6.selectedItem;
+            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, (0, _defineProperty2.default)({}, 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);
+          }
+        }));
+        break;
+    }
+
+    if (isPanel) {
+      return /*#__PURE__*/_react.default.createElement(_react2.Layer, null, filter);
+    }
+
+    return filter;
+  };
+
+  return {
+    filtersState: filtersState,
+    setFiltersState: setFiltersState,
+    prevFiltersObjectArrayRef: prevFiltersObjectArrayRef,
+    prevFiltersRef: prevFiltersRef,
+    revertToPreviousFilters: revertToPreviousFilters,
+    reset: reset,
+    renderFilter: renderFilter,
+    filtersObjectArray: filtersObjectArray
+  };
+};
+
+var _default = useFilters;
+exports.default = _default;

package/lib/components/Datagrid/Datagrid/addons/Filtering/utils.js

@@ -23,7 +23,7 @@ var getInitialStateFromFilters = function getInitialStateFromFilters(filters) {
         column = _ref.column,
         props = _ref.props;
 
-    if (type === 'checkbox') {
+    if (type === _constants.CHECKBOX) {
       initialFilterState[column] = {
         value: props.Checkbox.map(function (_ref2) {
           var id = _ref2.id,
@@ -38,22 +38,22 @@ var getInitialStateFromFilters = function getInitialStateFromFilters(filters) {
         }),
         type: type
       };
-    } else if (type === 'date') {
+    } else if (type === _constants.DATE) {
       initialFilterState[column] = {
         value: [null, null],
         type: type
       };
-    } else if (type === 'number') {
+    } else if (type === _constants.NUMBER) {
       initialFilterState[column] = {
         value: '',
         type: type
       };
-    } else if (type === 'radio') {
+    } else if (type === _constants.RADIO) {
       initialFilterState[column] = {
         value: '',
         type: type
       };
-    } else if (type === 'dropdown') {
+    } else if (type === _constants.DROPDOWN) {
       initialFilterState[column] = {
         value: '',
         type: type

package/lib/components/Datagrid/utils/DatagridActions.js

@@ -41,7 +41,7 @@ var blockClass = "".concat(_settings.pkg.prefix, "--datagrid");
 
 var DatagridActions = function DatagridActions(datagridState) {
   var _useContext = (0, _react.useContext)(_Filtering.FilterContext),
-      setLeftPanelOpen = _useContext.setLeftPanelOpen;
+      setPanelOpen = _useContext.setPanelOpen;
 
   var selectedFlatRows = datagridState.selectedFlatRows,
       setGlobalFilter = datagridState.setGlobalFilter,
@@ -87,7 +87,7 @@ var DatagridActions = function DatagridActions(datagridState) {
       iconDescription: filterProps.panelIconDescription,
       className: "".concat(blockClass, "-filter-panel-open-button"),
       onClick: function onClick() {
-        return setLeftPanelOpen(function (open) {
+        return setPanelOpen(function (open) {
           return !open;
         });
       },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/ibm-products",
   "description": "Carbon for IBM Products",
-  "version": "2.0.0-rc.20",
+  "version": "2.0.0-rc.21",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -94,5 +94,5 @@
     "react": "^16.8.6 || ^17.0.1",
     "react-dom": "^16.8.6 || ^17.0.1"
   },
-  "gitHead": "7cc1856159813001293987ec197c8e1a2db85123"
+  "gitHead": "18e39051d3cdcf186d14a87665f958dd14429927"
 }

package/scss/components/Datagrid/styles/_datagrid.scss

@@ -445,7 +445,9 @@
   }
 
   .#{$block-class}__table-toolbar {
+    display: flex;
     flex: 1 0 auto;
+    align-items: flex-end;
   }
 
   .#{c4p-settings.$carbon-prefix}--table-toolbar {
@@ -456,10 +458,6 @@
     flex: 1 1 100%;
   }
 
-  .#{c4p-settings.$carbon-prefix}--table-toolbar {
-    padding-top: $spacing-07;
-  }
-
   .#{$block-class}__toolbar-divider {
     position: relative;
   }

package/scss/components/OptionsTile/_options-tile.scss

@@ -21,12 +21,19 @@
 $block-class: #{c4p-settings.$pkg-prefix}--options-tile;
 
 .#{$block-class} {
-  border-bottom: 1px solid $border-subtle-01;
-  background-color: $layer-01;
+  position: relative;
+  border-bottom: 1px solid $border-subtle;
+  background-color: $layer;
 }
 
 .#{$block-class}__toggle-container {
-  position: relative;
+  position: absolute;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  width: calc(
+    #{$spacing-05} + 2rem + #{$spacing-05}
+  ); // spacing + toggle width + spacing
 }
 
 .#{$block-class}__toggle {