@carbon/ibm-products 1.6.1 → 1.9.0

package/es/components/DataSpreadsheet/DataSpreadsheet.js

@@ -0,0 +1,454 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["cellSize", "className", "columns", "data", "id", "onActiveCellChange"];
+
+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 portions of React that are needed.
+import React, { useMemo, useRef, useEffect, useState, useCallback } from 'react';
+import { useBlockLayout, useTable } from 'react-table'; // Other standard imports.
+
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg } from '../../settings';
+import { getScrollbarWidth } from '../../global/js/utils/getScrollbarWidth';
+import { DataSpreadsheetBody } from './DataSpreadsheetBody';
+import { getCellSize } from './getCellSize';
+import { DataSpreadsheetHeader } from './DataSpreadsheetHeader';
+import { useActiveElement } from '../../global/js/hooks';
+import { createActiveCellFn } from './createActiveCellFn'; // cspell:words rowcount colcount
+// The block part of our conventional BEM class names (blockClass__E--M).
+
+var blockClass = "".concat(pkg.prefix, "--data-spreadsheet");
+var componentName = 'DataSpreadsheet'; // Default values for props
+
+var defaults = {
+  cellSize: 'standard',
+  columns: Object.freeze([]),
+  data: Object.freeze([])
+};
+/**
+ * DataSpreadsheet: used to organize and display large amounts of structured data, separated by columns and rows in a grid-like format.
+ */
+
+export var DataSpreadsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var _ref$cellSize = _ref.cellSize,
+      cellSize = _ref$cellSize === void 0 ? defaults.cellSize : _ref$cellSize,
+      className = _ref.className,
+      _ref$columns = _ref.columns,
+      columns = _ref$columns === void 0 ? defaults.columns : _ref$columns,
+      _ref$data = _ref.data,
+      data = _ref$data === void 0 ? defaults.data : _ref$data,
+      id = _ref.id,
+      onActiveCellChange = _ref.onActiveCellChange,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  var focusedElement = useActiveElement();
+
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      containerHasFocus = _useState2[0],
+      setContainerHasFocus = _useState2[1];
+
+  var _useState3 = useState(null),
+      _useState4 = _slicedToArray(_useState3, 2),
+      activeCellCoordinates = _useState4[0],
+      setActiveCellCoordinates = _useState4[1];
+
+  var _useState5 = useState([]),
+      _useState6 = _slicedToArray(_useState5, 2),
+      selectionAreas = _useState6[0],
+      setSelectionAreas = _useState6[1];
+
+  var _useState7 = useState(false),
+      _useState8 = _slicedToArray(_useState7, 2),
+      clickAndHoldActive = _useState8[0],
+      setClickAndHoldActive = _useState8[1];
+
+  var _useState9 = useState(null),
+      _useState10 = _slicedToArray(_useState9, 2),
+      currentMatcher = _useState10[0],
+      setCurrentMatcher = _useState10[1];
+
+  var cellSizeValue = getCellSize(cellSize);
+  var defaultColumn = useMemo(function () {
+    return {
+      width: 150,
+      rowHeaderWidth: 64,
+      rowHeight: cellSizeValue
+    };
+  }, [cellSizeValue]);
+  var scrollBarSize = useMemo(function () {
+    return getScrollbarWidth();
+  }, []);
+
+  var _useTable = useTable({
+    columns: columns,
+    data: data,
+    defaultColumn: defaultColumn
+  }, useBlockLayout),
+      getTableProps = _useTable.getTableProps,
+      getTableBodyProps = _useTable.getTableBodyProps,
+      headerGroups = _useTable.headerGroups,
+      rows = _useTable.rows,
+      totalColumnsWidth = _useTable.totalColumnsWidth,
+      prepareRow = _useTable.prepareRow; // Reset everything when spreadsheet loses focus
+
+
+  useEffect(function () {
+    if (!focusedElement.classList.contains("".concat(blockClass, "--interactive-cell-element"))) {
+      setContainerHasFocus(false);
+      removeActiveCell();
+    }
+
+    if (focusedElement.classList.contains(blockClass) || focusedElement.classList.contains("".concat(blockClass, "--interactive-cell-element"))) {
+      setContainerHasFocus(true);
+    }
+  }, [focusedElement, removeActiveCell]); // Removes the active cell element
+
+  var removeActiveCell = useCallback(function () {
+    var activeCellHighlight = spreadsheetRef.current.querySelector(".".concat(blockClass, "__active-cell--highlight"));
+
+    if (activeCellHighlight) {
+      activeCellHighlight.remove();
+    }
+  }, [spreadsheetRef]); // Removes the cell selection elements
+
+  var removeCellSelections = useCallback(function () {
+    var cellSelections = spreadsheetRef.current.querySelectorAll(".".concat(blockClass, "__selection-area--element"));
+    Array.from(cellSelections).forEach(function (element) {
+      return element.remove();
+    });
+  }, [spreadsheetRef]); // Click outside useEffect
+
+  useEffect(function () {
+    var handleOutsideClick = function handleOutsideClick(event) {
+      if (!spreadsheetRef.current || spreadsheetRef.current.contains(event.target) || event.target.classList.contains("".concat(blockClass, "__active-cell--highlight"))) {
+        return;
+      }
+
+      setSelectionAreas([]);
+      removeActiveCell();
+      removeCellSelections();
+      setContainerHasFocus(false);
+      setActiveCellCoordinates(null);
+    };
+
+    document.addEventListener('click', handleOutsideClick);
+    return function () {
+      document.removeEventListener('click', handleOutsideClick);
+    };
+  }, [spreadsheetRef, removeActiveCell, removeCellSelections]);
+  var createActiveCell = useCallback(function (_ref2) {
+    var placementElement = _ref2.placementElement,
+        coords = _ref2.coords,
+        _ref2$addToHeader = _ref2.addToHeader,
+        addToHeader = _ref2$addToHeader === void 0 ? false : _ref2$addToHeader;
+    var activeCellFullData = typeof (coords === null || coords === void 0 ? void 0 : coords.column) === 'number' && typeof (coords === null || coords === void 0 ? void 0 : coords.row) === 'number' ? rows[coords === null || coords === void 0 ? void 0 : coords.row].cells[coords === null || coords === void 0 ? void 0 : coords.column] : null;
+    var activeCellValue = activeCellFullData ? Object.values(activeCellFullData.row.values)[coords === null || coords === void 0 ? void 0 : coords.column] : null;
+    createActiveCellFn({
+      placementElement: placementElement,
+      coords: coords,
+      addToHeader: addToHeader,
+      contextRef: spreadsheetRef,
+      blockClass: blockClass,
+      onActiveCellChange: onActiveCellChange,
+      activeCellValue: activeCellValue
+    });
+  }, [spreadsheetRef, rows, onActiveCellChange]);
+  var handleInitialArrowPress = useCallback(function () {
+    // If activeCellCoordinates is null then we need to set an initial value
+    // which will place the activeCell on the select all cell/button
+    if (!activeCellCoordinates) {
+      setActiveCellCoordinates({
+        column: 'header',
+        row: 'header'
+      });
+    }
+
+    return;
+  }, [activeCellCoordinates]);
+
+  var updateActiveCellCoordinates = function updateActiveCellCoordinates(_ref3) {
+    var coords = _ref3.coords,
+        updatedValue = _ref3.updatedValue;
+    setActiveCellCoordinates(_objectSpread(_objectSpread({}, coords), updatedValue));
+  };
+
+  var handleKeyPress = useCallback(function (event) {
+    var keyCode = event.keyCode; // Command keys need to be returned as there is default browser behavior with these keys
+
+    if (keyCode === 91 || keyCode === 93) {
+      return;
+    } // Prevent arrow keys, home key, and end key from scrolling the page when the data spreadsheet container has focus
+
+
+    if ([35, 36, 37, 38, 39, 40].indexOf(keyCode) > -1) {
+      event.preventDefault();
+    } // Clear out all cell selection areas if user uses any arrow key
+
+
+    if ([37, 38, 39, 40].indexOf(keyCode) > -1) {
+      if (selectionAreas !== null && selectionAreas !== void 0 && selectionAreas.length) {
+        setSelectionAreas([]);
+        removeCellSelections();
+      }
+    }
+
+    switch (keyCode) {
+      // Tab
+      case 9:
+        {
+          setSelectionAreas([]);
+          removeActiveCell();
+          setContainerHasFocus(false);
+          setActiveCellCoordinates(null);
+          break;
+        }
+      // Left
+
+      case 37:
+        {
+          handleInitialArrowPress();
+
+          var coordinatesClone = _objectSpread({}, activeCellCoordinates);
+
+          if (coordinatesClone.column === 'header') {
+            return;
+          }
+
+          if (typeof coordinatesClone.column === 'number') {
+            if (coordinatesClone.column === 0) {
+              updateActiveCellCoordinates({
+                coords: coordinatesClone,
+                updatedValue: {
+                  column: 'header'
+                }
+              });
+              return;
+            }
+
+            updateActiveCellCoordinates({
+              coords: coordinatesClone,
+              updatedValue: {
+                column: coordinatesClone.column - 1
+              }
+            });
+          }
+
+          break;
+        }
+      // Up
+
+      case 38:
+        {
+          handleInitialArrowPress();
+
+          var _coordinatesClone = _objectSpread({}, activeCellCoordinates);
+
+          if (_coordinatesClone.row === 'header') {
+            return;
+          }
+
+          if (typeof _coordinatesClone.row === 'number') {
+            // set row back to header if we are at index 0
+            if (_coordinatesClone.row === 0) {
+              updateActiveCellCoordinates({
+                coords: _coordinatesClone,
+                updatedValue: {
+                  row: 'header'
+                }
+              });
+              return;
+            } // if we are at any other index than 0, subtract 1 from current row index
+
+
+            updateActiveCellCoordinates({
+              coords: _coordinatesClone,
+              updatedValue: {
+                row: _coordinatesClone.row - 1
+              }
+            });
+          }
+
+          break;
+        }
+      // Right
+
+      case 39:
+        {
+          handleInitialArrowPress();
+
+          var _coordinatesClone2 = _objectSpread({}, activeCellCoordinates);
+
+          if (_coordinatesClone2.column === 'header') {
+            updateActiveCellCoordinates({
+              coords: _coordinatesClone2,
+              updatedValue: {
+                column: 0
+              }
+            });
+          }
+
+          if (typeof _coordinatesClone2.column === 'number') {
+            // Prevent active cell coordinates from updating if the active
+            // cell is in the last column, ie we can't go any further to the right
+            if (columns.length - 1 === _coordinatesClone2.column) {
+              return;
+            }
+
+            updateActiveCellCoordinates({
+              coords: _coordinatesClone2,
+              updatedValue: {
+                column: _coordinatesClone2.column + 1
+              }
+            });
+          }
+
+          break;
+        }
+      // Down
+
+      case 40:
+        {
+          handleInitialArrowPress();
+
+          var _coordinatesClone3 = _objectSpread({}, activeCellCoordinates);
+
+          if (_coordinatesClone3.row === 'header') {
+            updateActiveCellCoordinates({
+              coords: _coordinatesClone3,
+              updatedValue: {
+                row: 0
+              }
+            });
+          }
+
+          if (typeof _coordinatesClone3.row === 'number') {
+            // Prevent active cell coordinates from updating if the active
+            // cell is in the last row, ie we can't go any further down since
+            // we are in the last row
+            if (rows.length - 1 === _coordinatesClone3.row) {
+              return;
+            }
+
+            updateActiveCellCoordinates({
+              coords: _coordinatesClone3,
+              updatedValue: {
+                row: _coordinatesClone3.row + 1
+              }
+            });
+          }
+
+          break;
+        }
+    }
+  }, [handleInitialArrowPress, activeCellCoordinates, selectionAreas === null || selectionAreas === void 0 ? void 0 : selectionAreas.length, removeCellSelections, removeActiveCell, columns.length, rows.length]); // Adds active cell highlight to correct cell onKeyDown
+
+  useEffect(function () {
+    var activeCellPlacementElement = spreadsheetRef === null || spreadsheetRef === void 0 ? void 0 : spreadsheetRef.current.querySelector("[data-row-index=\"".concat(activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row, "\"][data-column-index=\"").concat(activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.column, "\"]"));
+    var shouldPlaceActiveCellInHeader = (activeCellCoordinates === null || activeCellCoordinates === void 0 ? void 0 : activeCellCoordinates.row) === 'header' && true;
+    var selectAllElement = spreadsheetRef === null || spreadsheetRef === void 0 ? void 0 : spreadsheetRef.current.querySelector("[data-row-index=\"header\"][data-column-index=\"header\"]");
+
+    if (containerHasFocus) {
+      createActiveCell({
+        placementElement: activeCellCoordinates ? activeCellPlacementElement : selectAllElement,
+        coords: activeCellCoordinates,
+        addToHeader: shouldPlaceActiveCellInHeader
+      });
+    }
+  }, [activeCellCoordinates, spreadsheetRef, createActiveCell, containerHasFocus]);
+  var localRef = useRef();
+  var spreadsheetRef = ref || localRef;
+  return /*#__PURE__*/React.createElement("div", _extends({}, rest, getTableProps(), getDevtoolsProps(componentName), {
+    className: cx(blockClass, className, _defineProperty({}, "".concat(blockClass, "__container-has-focus"), containerHasFocus)),
+    ref: spreadsheetRef,
+    role: "grid",
+    tabIndex: 0,
+    "aria-rowcount": (rows === null || rows === void 0 ? void 0 : rows.length) || 0,
+    "aria-colcount": (columns === null || columns === void 0 ? void 0 : columns.length) || 0,
+    onKeyDown: handleKeyPress,
+    onFocus: function onFocus() {
+      return setContainerHasFocus(true);
+    }
+  }), /*#__PURE__*/React.createElement(DataSpreadsheetHeader, {
+    cellSizeValue: cellSizeValue,
+    defaultColumn: defaultColumn,
+    headerGroups: headerGroups
+  }), /*#__PURE__*/React.createElement(DataSpreadsheetBody, {
+    clickAndHoldActive: clickAndHoldActive,
+    setClickAndHoldActive: setClickAndHoldActive,
+    currentMatcher: currentMatcher,
+    setCurrentMatcher: setCurrentMatcher,
+    setContainerHasFocus: setContainerHasFocus,
+    selectionAreas: selectionAreas,
+    setSelectionAreas: setSelectionAreas,
+    cellSize: cellSize,
+    defaultColumn: defaultColumn,
+    getTableBodyProps: getTableBodyProps,
+    onActiveCellChange: onActiveCellChange,
+    prepareRow: prepareRow,
+    rows: rows,
+    setActiveCellCoordinates: setActiveCellCoordinates,
+    scrollBarSize: scrollBarSize,
+    totalColumnsWidth: totalColumnsWidth,
+    id: id
+  }));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+DataSpreadsheet = pkg.checkComponentEnabled(DataSpreadsheet, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+DataSpreadsheet.displayName = componentName; // The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+
+DataSpreadsheet.propTypes = {
+  /**
+   * Specifies the cell height
+   */
+  cellSize: PropTypes.oneOf(['compact', 'standard', 'medium', 'large']),
+
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+
+  /**
+   * The data that will build the column headers
+   */
+  columns: PropTypes.arrayOf(PropTypes.shape({
+    Header: PropTypes.string,
+    accessor: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
+    Cell: PropTypes.func // optional cell formatter
+
+  })),
+
+  /**
+   * The spreadsheet data that will be rendered in the body of the spreadsheet component
+   */
+  data: PropTypes.arrayOf(PropTypes.shape),
+
+  /**
+   * The spreadsheet id
+   */
+  id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+
+  /**
+   * The event handler that is called when the active cell changes
+   */
+  onActiveCellChange: PropTypes.func
+  /* TODO: add types and DocGen for all props. */
+
+};