@carbon/ibm-products 1.14.0 → 1.17.0

package/es/components/DataSpreadsheet/utils/generateData.js

@@ -24,28 +24,36 @@ var range = function range(len) {
   return arr;
 };
 
-var newPet = function newPet() {
-  return {
+var newPet = function newPet(extraColumns) {
+  var extraDataProps = extraColumns && {
+    ownerName: petNames[Math.floor(Math.random() * petNames.length)],
+    weight: Math.floor(Math.random() * 40)
+  };
+  var defaultPet = {
     petType: pets[Math.floor(Math.random() * pets.length)],
     firstName: petNames[Math.floor(Math.random() * petNames.length)],
     age: Math.floor(Math.random() * 30),
     visits: Math.floor(Math.random() * 40),
     health: Math.floor(Math.random() * 100)
   };
-};
 
-export var generateData = function generateData() {
-  for (var _len = arguments.length, lens = new Array(_len), _key = 0; _key < _len; _key++) {
-    lens[_key] = arguments[_key];
+  if (extraColumns) {
+    return _objectSpread(_objectSpread({}, defaultPet), extraDataProps);
   }
 
+  return defaultPet;
+};
+
+export var generateData = function generateData(_ref) {
+  var rows = _ref.rows,
+      extraColumns = _ref.extraColumns;
+
   var makeDataLevel = function makeDataLevel() {
     var depth = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    var lens = [rows];
     var len = lens[depth];
     return range(len).map(function () {
-      return _objectSpread(_objectSpread({}, newPet()), {}, {
-        subRows: lens[depth + 1] ? makeDataLevel(depth + 1) : undefined
-      });
+      return _objectSpread({}, newPet(extraColumns));
     });
   };
 

package/es/components/DataSpreadsheet/utils/getSelectionAreaPoints.js

@@ -0,0 +1,18 @@
+/**
+ * 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 var getSelectionAreaPoints = function getSelectionAreaPoints(area) {
+  var greatestRowIndex = Math.max(area.point1.row, area.point2.row);
+  var greatestColumnIndex = Math.max(area.point1.column, area.point2.column);
+  var lowestRowIndex = Math.min(area.point1.row, area.point2.row);
+  var lowestColumnIndex = Math.min(area.point1.column, area.point2.column);
+  return {
+    greatestRowIndex: greatestRowIndex,
+    greatestColumnIndex: greatestColumnIndex,
+    lowestColumnIndex: lowestColumnIndex,
+    lowestRowIndex: lowestRowIndex
+  };
+};

package/es/components/DataSpreadsheet/utils/getSpreadsheetWidth.js

@@ -0,0 +1,30 @@
+/**
+ * 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 { px } from '@carbon/layout';
+export var getSpreadsheetWidth = function getSpreadsheetWidth(_ref) {
+  var type = _ref.type,
+      headerGroup = _ref.headerGroup,
+      scrollBarSizeValue = _ref.scrollBarSizeValue,
+      totalVisibleColumns = _ref.totalVisibleColumns,
+      defaultColumn = _ref.defaultColumn,
+      totalColumnsWidth = _ref.totalColumnsWidth;
+  var additionalWidth = scrollBarSizeValue + defaultColumn.rowHeaderWidth;
+
+  if (!totalVisibleColumns) {
+    if (type === 'header') {
+      return px(parseInt(headerGroup.getHeaderGroupProps().style.width) + additionalWidth);
+    }
+
+    if (type !== 'header') {
+      return totalColumnsWidth + additionalWidth;
+    }
+  }
+
+  if (totalVisibleColumns) {
+    return totalVisibleColumns * (defaultColumn === null || defaultColumn === void 0 ? void 0 : defaultColumn.width) + additionalWidth;
+  }
+};

package/es/components/DataSpreadsheet/utils/handleActiveCellInSelectionEnter.js

@@ -0,0 +1,121 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+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, 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 { getSelectionAreaPoints } from './getSelectionAreaPoints';
+export var handleActiveCellInSelectionEnter = function handleActiveCellInSelectionEnter(_ref) {
+  var activeCellInsideSelectionArea = _ref.activeCellInsideSelectionArea,
+      activeCellCoordinates = _ref.activeCellCoordinates,
+      activeCellRef = _ref.activeCellRef,
+      selectionAreas = _ref.selectionAreas,
+      updateActiveCellCoordinates = _ref.updateActiveCellCoordinates;
+
+  if (!activeCellInsideSelectionArea) {
+    return;
+  }
+
+  var activeCellSelectionId = activeCellRef.current.getAttribute('data-selection-id');
+  var activeCellIndexInSelectionAreas = selectionAreas.findIndex(function (item) {
+    return item.matcher === activeCellSelectionId;
+  });
+  var selectionAreaToNavigate = selectionAreas[activeCellIndexInSelectionAreas];
+
+  var _getSelectionAreaPoin = getSelectionAreaPoints(selectionAreaToNavigate),
+      lowestColumnIndex = _getSelectionAreaPoin.lowestColumnIndex,
+      lowestRowIndex = _getSelectionAreaPoin.lowestRowIndex,
+      greatestColumnIndex = _getSelectionAreaPoin.greatestColumnIndex,
+      greatestRowIndex = _getSelectionAreaPoin.greatestRowIndex; // Move active cell down one row if possible
+
+
+  var coordinatesClone = _objectSpread({}, activeCellCoordinates);
+
+  if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row) < greatestRowIndex) {
+    updateActiveCellCoordinates({
+      coords: coordinatesClone,
+      updatedValue: {
+        row: (coordinatesClone === null || coordinatesClone === void 0 ? void 0 : coordinatesClone.row) + 1
+      },
+      optOutOfSelectionAreaUpdate: true
+    });
+  } // Move active cell to next column of selection area if it exists
+  // If not, find the next selection area and update active cell to
+  // be the first cell in that selection
+
+
+  if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row) === greatestRowIndex) {
+    if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column) < greatestColumnIndex) {
+      updateActiveCellCoordinates({
+        coords: coordinatesClone,
+        updatedValue: {
+          column: (coordinatesClone === null || coordinatesClone === void 0 ? void 0 : coordinatesClone.column) + 1,
+          row: lowestRowIndex
+        },
+        optOutOfSelectionAreaUpdate: true
+      });
+    } // Move to next selection area if there is one, or back to
+    // the beginning of the current selection
+
+
+    if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column) === greatestColumnIndex) {
+      if (selectionAreas.length > 1) {
+        if (selectionAreas[activeCellIndexInSelectionAreas + 1]) {
+          // Update activeCellRef data-selection-id attribute to the matcher of the next selection area
+          activeCellRef.current.setAttribute('data-selection-id', selectionAreas[activeCellIndexInSelectionAreas + 1].matcher);
+          var nextSelectionArea = selectionAreas[activeCellIndexInSelectionAreas + 1];
+
+          var _getSelectionAreaPoin2 = getSelectionAreaPoints(nextSelectionArea),
+              _lowestColumnIndex = _getSelectionAreaPoin2.lowestColumnIndex,
+              _lowestRowIndex = _getSelectionAreaPoin2.lowestRowIndex;
+
+          updateActiveCellCoordinates({
+            coords: coordinatesClone,
+            updatedValue: {
+              column: _lowestColumnIndex,
+              row: _lowestRowIndex
+            },
+            optOutOfSelectionAreaUpdate: true
+          });
+          return;
+        } else {
+          // There are multiple selection areas and the active cell is in the last one
+          // So we need to move the active cell to the first cell in the first selection area
+          activeCellRef.current.setAttribute('data-selection-id', selectionAreas[0].matcher);
+          var firstSelectionArea = selectionAreas[0];
+
+          var _getSelectionAreaPoin3 = getSelectionAreaPoints(firstSelectionArea),
+              _lowestColumnIndex2 = _getSelectionAreaPoin3.lowestColumnIndex,
+              _lowestRowIndex2 = _getSelectionAreaPoin3.lowestRowIndex;
+
+          updateActiveCellCoordinates({
+            coords: coordinatesClone,
+            updatedValue: {
+              column: _lowestColumnIndex2,
+              row: _lowestRowIndex2
+            },
+            optOutOfSelectionAreaUpdate: true
+          });
+        }
+      } // Only one selection area, go back to first cell in the selection
+
+
+      if (selectionAreas.length === 1) {
+        return updateActiveCellCoordinates({
+          coords: coordinatesClone,
+          updatedValue: {
+            column: lowestColumnIndex,
+            row: lowestRowIndex
+          },
+          optOutOfSelectionAreaUpdate: true
+        });
+      }
+    }
+  }
+};

package/es/components/DataSpreadsheet/utils/handleActiveCellInSelectionTab.js

@@ -0,0 +1,108 @@
+/**
+ * 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 { getSelectionAreaPoints } from './getSelectionAreaPoints';
+export var handleActiveCellInSelectionTab = function handleActiveCellInSelectionTab(_ref) {
+  var activeCellInsideSelectionArea = _ref.activeCellInsideSelectionArea,
+      activeCellCoordinates = _ref.activeCellCoordinates,
+      activeCellRef = _ref.activeCellRef,
+      selectionAreas = _ref.selectionAreas,
+      updateActiveCellCoordinates = _ref.updateActiveCellCoordinates;
+
+  if (!activeCellInsideSelectionArea) {
+    return;
+  }
+
+  var activeCellSelectionId = activeCellRef.current.getAttribute('data-selection-id');
+  var activeCellIndexInSelectionAreas = selectionAreas.findIndex(function (item) {
+    return item.matcher === activeCellSelectionId;
+  });
+  var selectionAreaToNavigate = selectionAreas[activeCellIndexInSelectionAreas];
+
+  var _getSelectionAreaPoin = getSelectionAreaPoints(selectionAreaToNavigate),
+      lowestColumnIndex = _getSelectionAreaPoin.lowestColumnIndex,
+      lowestRowIndex = _getSelectionAreaPoin.lowestRowIndex,
+      greatestColumnIndex = _getSelectionAreaPoin.greatestColumnIndex,
+      greatestRowIndex = _getSelectionAreaPoin.greatestRowIndex; // Move active cell to next column in selection area
+
+
+  if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column) < greatestColumnIndex) {
+    updateActiveCellCoordinates({
+      updatedValue: {
+        column: (activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column) + 1
+      },
+      optOutOfSelectionAreaUpdate: true
+    });
+  } // Move active cell to next row of selection area if it exists
+  // If not, find the next selection area and update active cell to
+  // be the first cell in that selection
+
+
+  if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column) === greatestColumnIndex) {
+    if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row) < greatestRowIndex) {
+      updateActiveCellCoordinates({
+        updatedValue: {
+          column: lowestColumnIndex,
+          row: (activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row) + 1
+        },
+        optOutOfSelectionAreaUpdate: true
+      });
+    } // Move to next selection area if there is on, or back to
+    // the beginning of the current selection
+
+
+    if ((activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row) === greatestRowIndex) {
+      if (selectionAreas.length > 1) {
+        if (selectionAreas[activeCellIndexInSelectionAreas + 1]) {
+          // Update activeCellRef data-selection-id attribute to the matcher of the next selection area
+          activeCellRef.current.setAttribute('data-selection-id', selectionAreas[activeCellIndexInSelectionAreas + 1].matcher);
+          var nextSelectionArea = selectionAreas[activeCellIndexInSelectionAreas + 1];
+
+          var _getSelectionAreaPoin2 = getSelectionAreaPoints(nextSelectionArea),
+              _lowestColumnIndex = _getSelectionAreaPoin2.lowestColumnIndex,
+              _lowestRowIndex = _getSelectionAreaPoin2.lowestRowIndex;
+
+          updateActiveCellCoordinates({
+            updatedValue: {
+              column: _lowestColumnIndex,
+              row: _lowestRowIndex
+            },
+            optOutOfSelectionAreaUpdate: true
+          });
+          return;
+        } else {
+          // There are multiple selection areas and the active cell is in the last one
+          // So we need to move the active cell to the first cell in the first selection area
+          activeCellRef.current.setAttribute('data-selection-id', selectionAreas[0].matcher);
+          var firstSelectionArea = selectionAreas[0];
+
+          var _getSelectionAreaPoin3 = getSelectionAreaPoints(firstSelectionArea),
+              _lowestColumnIndex2 = _getSelectionAreaPoin3.lowestColumnIndex,
+              _lowestRowIndex2 = _getSelectionAreaPoin3.lowestRowIndex;
+
+          updateActiveCellCoordinates({
+            updatedValue: {
+              column: _lowestColumnIndex2,
+              row: _lowestRowIndex2
+            },
+            optOutOfSelectionAreaUpdate: true
+          });
+        }
+      } // Only one selection area, go back to first cell in the selection
+
+
+      if (selectionAreas.length === 1) {
+        return updateActiveCellCoordinates({
+          updatedValue: {
+            column: lowestColumnIndex,
+            row: lowestRowIndex
+          },
+          optOutOfSelectionAreaUpdate: true
+        });
+      }
+    }
+  }
+};

package/es/components/DataSpreadsheet/utils/handleEditSubmit.js

@@ -0,0 +1,87 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+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, 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 { removeCellSelections } from './removeCellSelections';
+import uuidv4 from '../../../global/js/utils/uuidv4'; // Update the data
+
+export var handleEditSubmit = function handleEditSubmit(_ref) {
+  var activeCellCoordinates = _ref.activeCellCoordinates,
+      cellEditorRulerRef = _ref.cellEditorRulerRef,
+      columns = _ref.columns,
+      previousState = _ref.previousState,
+      removeCellEditor = _ref.removeCellEditor,
+      rows = _ref.rows,
+      setActiveCellCoordinates = _ref.setActiveCellCoordinates,
+      setCurrentMatcher = _ref.setCurrentMatcher,
+      setSelectionAreas = _ref.setSelectionAreas,
+      spreadsheetRef = _ref.spreadsheetRef,
+      updateData = _ref.updateData;
+  return function (event) {
+    var key = event.key;
+
+    var updateSelectionAreaOnCellEditSubmit = function updateSelectionAreaOnCellEditSubmit(_ref2) {
+      var type = _ref2.type;
+
+      var submitEditChanges = function submitEditChanges() {
+        var prevCoords = previousState === null || previousState === void 0 ? void 0 : previousState.activeCellCoordinates;
+        var cellProps = rows[prevCoords === null || prevCoords === void 0 ? void 0 : prevCoords.row].cells[prevCoords === null || prevCoords === void 0 ? void 0 : prevCoords.column];
+        removeCellEditor();
+        updateData(prevCoords === null || prevCoords === void 0 ? void 0 : prevCoords.row, cellProps.column.id);
+      };
+
+      removeCellSelections({
+        spreadsheetRef: spreadsheetRef
+      });
+      submitEditChanges();
+      var tempMatcher = uuidv4();
+      var newSelectionArea = {
+        row: type === 'Enter' ? activeCellCoordinates.row === rows.length - 1 ? activeCellCoordinates.row : activeCellCoordinates.row + 1 : activeCellCoordinates.row,
+        column: type === 'Tab' ? activeCellCoordinates.column === columns.length - 1 ? activeCellCoordinates.column : activeCellCoordinates.column + 1 : activeCellCoordinates.column
+      };
+      setSelectionAreas([{
+        point1: newSelectionArea,
+        point2: newSelectionArea,
+        matcher: tempMatcher,
+        areaCreated: false
+      }]);
+      setCurrentMatcher(tempMatcher);
+      cellEditorRulerRef.current.textContent = '';
+    };
+
+    if (key === 'Enter') {
+      updateSelectionAreaOnCellEditSubmit({
+        type: 'Enter'
+      });
+      setActiveCellCoordinates(function (prev) {
+        return _objectSpread(_objectSpread({}, prev), {}, {
+          row: prev.row === rows.length - 1 ? prev.row : prev.row + 1 // do not move to next cell below if we're already in the last row
+
+        });
+      });
+    }
+
+    if (key === 'Tab') {
+      event.preventDefault();
+      updateSelectionAreaOnCellEditSubmit({
+        type: 'Tab'
+      });
+      setActiveCellCoordinates(function (prev) {
+        return _objectSpread(_objectSpread({}, prev), {}, {
+          column: prev.column === columns.length - 1 ? prev.column : prev.column + 1 // do not move to next cell below if we're already in the last column
+
+        });
+      });
+    }
+
+    return;
+  };
+};

package/es/components/DataSpreadsheet/utils/handleHeaderCellSelection.js

@@ -1,11 +1,15 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+
 /**
  * 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 { deepCloneObject } from '../../../global/js/utils/deepCloneObject';
 import uuidv4 from '../../../global/js/utils/uuidv4';
 import { removeCellSelections } from './removeCellSelections';
+import { checkActiveHeaderCell } from './checkActiveHeaderCell';
 export var handleHeaderCellSelection = function handleHeaderCellSelection(_ref) {
   var type = _ref.type,
       activeCellCoordinates = _ref.activeCellCoordinates,
@@ -17,8 +21,16 @@ export var handleHeaderCellSelection = function handleHeaderCellSelection(_ref)
       spreadsheetRef = _ref.spreadsheetRef,
       index = _ref.index,
       isKeyboard = _ref.isKeyboard,
-      setSelectionAreaData = _ref.setSelectionAreaData;
-  setSelectionAreaData([]);
+      setSelectionAreaData = _ref.setSelectionAreaData,
+      isHoldingCommandKey = _ref.isHoldingCommandKey;
+
+  if (!isHoldingCommandKey) {
+    setSelectionAreaData([]);
+    removeCellSelections({
+      spreadsheetRef: spreadsheetRef
+    });
+  }
+
   var rowValue = isKeyboard ? activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row : index;
   var columnValue = isKeyboard ? activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column : index;
   var point1 = {
@@ -36,13 +48,39 @@ export var handleHeaderCellSelection = function handleHeaderCellSelection(_ref)
     column: type === 'column' ? columnValue : 0
   });
   setCurrentMatcher(tempMatcher);
-  removeCellSelections({
-    spreadsheetRef: spreadsheetRef
-  });
-  setSelectionAreas([{
+  var newSelectionArea = {
     point1: point1,
     point2: point2,
     areaCreated: false,
-    matcher: tempMatcher
-  }]);
+    matcher: tempMatcher,
+    header: {
+      type: type,
+      index: index
+    }
+  };
+  setSelectionAreas(function (prev) {
+    var selectionsClone = deepCloneObject(prev);
+
+    if (isHoldingCommandKey) {
+      var selectionsFromHeaderCell = selectionsClone.filter(function (item) {
+        var _item$header;
+
+        return (_item$header = item.header) === null || _item$header === void 0 ? void 0 : _item$header.type;
+      });
+      var previouslyCreatedHeaderSelection = selectionsFromHeaderCell.filter(function (item) {
+        var _item$header2;
+
+        return ((_item$header2 = item.header) === null || _item$header2 === void 0 ? void 0 : _item$header2.type) === type;
+      });
+      var isHeaderPartOfPreviousSelection = checkActiveHeaderCell(index, previouslyCreatedHeaderSelection, type); // Prevents row/column header selections from being created multiple times
+
+      if (previouslyCreatedHeaderSelection.length && isHeaderPartOfPreviousSelection) {
+        return prev;
+      }
+
+      return [].concat(_toConsumableArray(prev), [newSelectionArea]);
+    }
+
+    return [newSelectionArea];
+  });
 };