@carbon/ibm-products 2.0.0-rc.10 → 2.0.0-rc.11

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

@@ -0,0 +1,424 @@
+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; }
+
+// @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.
+ */
+import { Filter } from '@carbon/react/icons';
+import { Button, Checkbox, DatePicker, DatePickerInput, Dropdown, FormGroup, NumberInput, RadioButton, RadioButtonGroup } 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 { getInitialStateFromFilters } from './utils';
+var blockClass = "".concat(pkg.prefix, "--datagrid");
+var componentClass = "".concat(blockClass, "-filter-flyout");
+
+var FilterFlyout = function FilterFlyout(_ref) {
+  var _cx2;
+
+  var _ref$updateMethod = _ref.updateMethod,
+      updateMethod = _ref$updateMethod === void 0 ? BATCH : _ref$updateMethod,
+      _ref$flyoutIconDescri = _ref.flyoutIconDescription,
+      flyoutIconDescription = _ref$flyoutIconDescri === void 0 ? 'Open filters' : _ref$flyoutIconDescri,
+      _ref$filters = _ref.filters,
+      filters = _ref$filters === void 0 ? [] : _ref$filters,
+      _ref$title = _ref.title,
+      title = _ref$title === void 0 ? 'Filter' : _ref$title,
+      _ref$primaryActionLab = _ref.primaryActionLabel,
+      primaryActionLabel = _ref$primaryActionLab === void 0 ? 'Apply' : _ref$primaryActionLab,
+      _ref$onFlyoutOpen = _ref.onFlyoutOpen,
+      onFlyoutOpen = _ref$onFlyoutOpen === void 0 ? function () {} : _ref$onFlyoutOpen,
+      _ref$onFlyoutClose = _ref.onFlyoutClose,
+      onFlyoutClose = _ref$onFlyoutClose === void 0 ? function () {} : _ref$onFlyoutClose,
+      _ref$onApply = _ref.onApply,
+      onApply = _ref$onApply === void 0 ? function () {} : _ref$onApply,
+      _ref$onCancel = _ref.onCancel,
+      onCancel = _ref$onCancel === void 0 ? function () {} : _ref$onCancel,
+      _ref$secondaryActionL = _ref.secondaryActionLabel,
+      secondaryActionLabel = _ref$secondaryActionL === void 0 ? 'Cancel' : _ref$secondaryActionL,
+      setAllFilters = _ref.setAllFilters;
+
+  /** 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),
+      _useInitialStateFromF2 = _slicedToArray(_useInitialStateFromF, 2),
+      filtersState = _useInitialStateFromF2[0],
+      setFiltersState = _useInitialStateFromF2[1];
+
+  var _useState3 = useState([]),
+      _useState4 = _slicedToArray(_useState3, 2),
+      filtersObjectArray = _useState4[0],
+      setFiltersObjectArray = _useState4[1];
+  /** Refs */
+
+
+  var filterFlyoutRef = useRef(null); // 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));
+  /** Memos */
+
+  var showActionSet = updateMethod === BATCH;
+  /** Methods */
+
+  var openFlyout = function openFlyout() {
+    setOpen(true);
+    onFlyoutOpen();
+  };
+
+  var closeFlyout = function closeFlyout() {
+    setOpen(false);
+    onFlyoutClose();
+  };
+
+  var apply = function apply() {
+    setAllFilters(filtersObjectArray);
+    closeFlyout();
+    onApply(); // 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);
+  };
+
+  var cancel = function cancel() {
+    // Reverting to previous filters only applies when using batch actions
+    if (updateMethod === BATCH) {
+      revertToPreviousFilters();
+      onCancel();
+    }
+
+    closeFlyout();
+  };
+
+  var reset = function reset() {
+    // Get the initial values for the filters
+    var initialFiltersState = getInitialStateFromFilters(filters);
+    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);
+  }; // 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 applyFilters = useCallback(function (_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[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
+      });
+    }
+
+    setFiltersObjectArray(filtersObjectArrayCopy); // Automatically apply the filters if the updateMethod is instant
+
+    if (updateMethod === INSTANT) {
+      setAllFilters(filtersObjectArrayCopy);
+    }
+  }, [setAllFilters, updateMethod, filtersObjectArray]);
+  /** Effects */
+
+  useClickOutside(filterFlyoutRef, function (target) {
+    var hasClickedOnDatePicker = target.closest('.flatpickr-calendar');
+
+    if (!open || hasClickedOnDatePicker) {
+      return;
+    }
+
+    cancel();
+  });
+  useEffect(function subscribeToEmitter() {
+    // This event is emitted from the DatagridToolbar component when clearFilters is clicked in FilterSummary
+    EventEmitter.subscribe(CLEAR_FILTERS, reset);
+  });
+  /** Render the individual filter component */
+
+  var renderFilter = useCallback(function (_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, {
+        onChange: function onChange(value) {
+          var _components$DatePicke, _components$DatePicke2;
+
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, value)));
+          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],
+        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)));
+    } else if (type === NUMBER) {
+      return /*#__PURE__*/React.createElement(NumberInput, _extends({
+        key: key,
+        step: 1,
+        allowEmpty: true,
+        hideSteppers: true
+      }, components.NumberInput, {
+        onChange: function onChange(event) {
+          var _components$NumberInp, _components$NumberInp2;
+
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, event.target.value)));
+          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]
+      }));
+    } else if (type === CHECKBOX) {
+      return /*#__PURE__*/React.createElement(FormGroup, _extends({
+        key: key
+      }, components.FormGroup), filtersState[column].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 foundCheckbox = checkboxCopy.find(function (checkbox) {
+              return checkbox.value === option.value;
+            });
+            foundCheckbox.selected = checked;
+            setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, checkboxCopy)));
+            applyFilters({
+              column: column,
+              value: _toConsumableArray(filtersState[column]),
+              type: type
+            });
+            (_option$onChange = option.onChange) === null || _option$onChange === void 0 ? void 0 : _option$onChange.call(option, checked);
+          },
+          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],
+        onChange: function onChange(selected) {
+          var _components$RadioButt, _components$RadioButt2;
+
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, selected)));
+          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);
+        }
+      }), 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));
+      })));
+    } else if (type === DROPDOWN) {
+      return /*#__PURE__*/React.createElement(Dropdown, _extends({
+        key: key
+      }, components.Dropdown, {
+        selectedItem: filtersState[column],
+        onChange: function onChange(_ref6) {
+          var _components$Dropdown$, _components$Dropdown;
+
+          var selectedItem = _ref6.selectedItem;
+          setFiltersState(_objectSpread(_objectSpread({}, filtersState), {}, _defineProperty({}, column, selectedItem)));
+          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);
+        }
+      }));
+    }
+  }, [filtersState, applyFilters, setFiltersState]);
+  /** Renders all filters */
+
+  var renderFilters = function renderFilters() {
+    return filters.map(renderFilter);
+  };
+
+  var renderActionSet = function renderActionSet() {
+    return showActionSet && /*#__PURE__*/React.createElement(ActionSet, {
+      actions: [{
+        key: 1,
+        kind: 'primary',
+        label: primaryActionLabel,
+        onClick: apply,
+        isExpressive: false
+      }, {
+        key: 3,
+        kind: 'secondary',
+        label: secondaryActionLabel,
+        onClick: cancel,
+        isExpressive: false
+      }],
+      size: "md",
+      buttonSize: "md"
+    });
+  };
+
+  return /*#__PURE__*/React.createElement("div", {
+    className: "".concat(componentClass, "__container")
+  }, /*#__PURE__*/React.createElement(Button, {
+    kind: "ghost",
+    hasIconOnly: true,
+    tooltipPosition: "bottom",
+    renderIcon: function renderIcon() {
+      return /*#__PURE__*/React.createElement(Filter, {
+        size: 16
+      });
+    },
+    iconDescription: flyoutIconDescription,
+    onClick: open ? closeFlyout : openFlyout,
+    className: cx("".concat(componentClass, "__trigger"), _defineProperty({}, "".concat(componentClass, "__trigger--open"), open))
+  }), /*#__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))
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(componentClass, "__inner-container")
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "".concat(componentClass, "__title")
+  }, title), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(componentClass, "__filters")
+  }, renderFilters())), renderActionSet()));
+};
+
+FilterFlyout.propTypes = {
+  /**
+   * Array of filters to render
+   */
+  filters: PropTypes.arrayOf(PropTypes.shape({
+    type: PropTypes.string.isRequired,
+    column: PropTypes.string.isRequired,
+    props: PropTypes.object.isRequired
+  })).isRequired,
+
+  /**
+   * Icon description for the filter flyout button
+   */
+  flyoutIconDescription: PropTypes.string,
+
+  /**
+   * Callback when the apply button is clicked
+   */
+  onApply: PropTypes.func,
+
+  /**
+   * Callback when the cancel button is clicked
+   */
+  onCancel: PropTypes.func,
+
+  /**
+   * Callback when the flyout closes
+   */
+  onFlyoutClose: PropTypes.func,
+
+  /**
+   * Callback when the flyout opens
+   */
+  onFlyoutOpen: PropTypes.func,
+
+  /**
+   * Label text of the primary action in the flyout
+   */
+  primaryActionLabel: PropTypes.string,
+
+  /**
+   * Label text of the secondary action in the flyout
+   */
+  secondaryActionLabel: PropTypes.string,
+
+  /**
+   * Function that sets all the filters, this comes from the datagridState
+   */
+  setAllFilters: PropTypes.func.isRequired,
+
+  /**
+   * Title of the filter flyout
+   */
+  title: PropTypes.string,
+
+  /**
+   * The update method used to apply the filters
+   */
+  updateMethod: PropTypes.oneOf([BATCH, INSTANT]).isRequired
+};
+export default FilterFlyout;

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

@@ -0,0 +1,83 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+
+/**
+ * Copyright IBM Corp. 2022, 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, { createContext } from 'react';
+import PropTypes from 'prop-types';
+import { DATE, DROPDOWN, NUMBER, RADIO, CHECKBOX } from './constants';
+export var FilterContext = /*#__PURE__*/createContext();
+var EventEmitter = {
+  events: {},
+  dispatch: function dispatch(event, data) {
+    if (!this.events[event]) {
+      return;
+    }
+
+    this.events[event].forEach(function (callback) {
+      return callback(data);
+    });
+  },
+  subscribe: function subscribe(event, callback) {
+    if (!this.events[event]) {
+      this.events[event] = [];
+    } else {
+      this.events[event].push(callback);
+    }
+  }
+};
+
+var prepareFiltersForTags = function prepareFiltersForTags(filters) {
+  var tags = [];
+  filters.forEach(function (_ref) {
+    var id = _ref.id,
+        type = _ref.type,
+        value = _ref.value;
+
+    if (type === DROPDOWN || type === RADIO || type === NUMBER) {
+      tags.push({
+        key: id,
+        value: value
+      });
+    } else if (type === DATE) {
+      var _value = _slicedToArray(value, 2),
+          startDate = _value[0],
+          endDate = _value[1];
+
+      tags.push({
+        key: id,
+        value: "".concat(startDate.toLocaleDateString(), " - ").concat(endDate.toLocaleDateString())
+      });
+    } else if (type === CHECKBOX) {
+      value.forEach(function (checkbox) {
+        if (checkbox.selected) {
+          tags.push({
+            key: id,
+            value: checkbox.value
+          });
+        }
+      });
+    }
+  });
+  return tags;
+};
+
+export var FilterProvider = function FilterProvider(_ref2) {
+  var children = _ref2.children,
+      filters = _ref2.filters;
+  var filterTags = prepareFiltersForTags(filters);
+  var value = {
+    filterTags: filterTags,
+    EventEmitter: EventEmitter
+  };
+  return /*#__PURE__*/React.createElement(FilterContext.Provider, {
+    value: value
+  }, children);
+};
+FilterProvider.propTypes = {
+  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
+  filters: PropTypes.arrayOf(PropTypes.object).isRequired
+};

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

@@ -0,0 +1,20 @@
+/**
+ * Copyright IBM Corp. 2022, 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.
+ */
+
+/** Constants for update methods can either be batch or instant */
+export var BATCH = 'batch';
+export var INSTANT = 'instant';
+/** Constants for filter type */
+
+export var DATE = 'date';
+export var NUMBER = 'number';
+export var CHECKBOX = 'checkbox';
+export var RADIO = 'radio';
+export var DROPDOWN = 'dropdown';
+/** Constants for event emitters */
+
+export var CLEAR_FILTERS = 'clearFilters';

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

@@ -0,0 +1,22 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+
+/*
+ * 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.
+ */
+import { useState } from 'react';
+import { getInitialStateFromFilters } from '../utils';
+
+var useInitialStateFromFilters = function useInitialStateFromFilters(filters) {
+  var _useState = useState(getInitialStateFromFilters(filters)),
+      _useState2 = _slicedToArray(_useState, 2),
+      state = _useState2[0],
+      setState = _useState2[1];
+
+  return [state, setState];
+};
+
+export default useInitialStateFromFilters;

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

@@ -0,0 +1,7 @@
+/**
+ * Copyright IBM Corp. 2022, 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.
+ */
+export { default as FilterFlyout } from './FilterFlyout';

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

@@ -0,0 +1,38 @@
+/**
+ * Copyright IBM Corp. 2022, 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.
+ */
+// This functions takes the filters passed in and makes an object to track it's state
+export var getInitialStateFromFilters = function getInitialStateFromFilters(filters) {
+  var initialFilterState = {};
+  filters.forEach(function (_ref) {
+    var type = _ref.type,
+        column = _ref.column,
+        props = _ref.props;
+
+    if (type === 'checkbox') {
+      initialFilterState[column] = props.Checkbox.map(function (_ref2) {
+        var id = _ref2.id,
+            labelText = _ref2.labelText,
+            value = _ref2.value;
+        return {
+          id: id,
+          labelText: labelText,
+          value: value,
+          selected: false
+        };
+      });
+    } else if (type === 'date') {
+      initialFilterState[column] = [undefined, undefined];
+    } else if (type === 'number') {
+      initialFilterState[column] = '';
+    } else if (type === 'radio') {
+      initialFilterState[column] = '';
+    } else if (type === 'dropdown') {
+      initialFilterState[column] = '';
+    }
+  });
+  return initialFilterState;
+};

package/es/components/Datagrid/index.js

@@ -22,4 +22,5 @@ export { default as useCustomizeColumns } from './useCustomizeColumns';
 export { default as useSelectAllWithToggle } from './useSelectAllToggle';
 export { default as useColumnCenterAlign } from './useColumnCenterAlign';
 export { default as useColumnOrder } from './useColumnOrder';
-export { default as useInlineEdit } from './useInlineEdit';
+export { default as useInlineEdit } from './useInlineEdit';
+export { default as useFiltering } from './useFiltering';