@carbon/ibm-products 2.0.0-rc.33 → 2.0.0-rc.38

package/es/components/Datagrid/Datagrid/addons/InlineEdit/handleGridKeyPress.js

@@ -0,0 +1,228 @@
+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 { carbon, pkg } from '../../../../../settings';
+import { handleMultipleKeys } from './handleMultipleKeys';
+import { getCellIdAsObject } from './InlineEditContext/getCellIdAsObject';
+var blockClass = "".concat(pkg.prefix, "--datagrid");
+export var handleGridKeyPress = function handleGridKeyPress(_ref) {
+  var event = _ref.event,
+    dispatch = _ref.dispatch,
+    state = _ref.state,
+    instance = _ref.instance,
+    keysPressedList = _ref.keysPressedList,
+    usingMac = _ref.usingMac;
+  var key = event.key;
+  var gridActive = state.gridActive,
+    activeCellId = state.activeCellId,
+    editId = state.editId;
+  var focusedCell = document.querySelector("#".concat(instance.tableId, " .").concat(blockClass, "__table-with-inline-edit [data-cell-id=\"").concat(activeCellId, "\"]"));
+
+  // If we reach this it means that tab was pressed while in
+  // edit mode which should not remove the focus from the grid
+  if (activeCellId === editId && key === 'Tab') {
+    // Attempting to exit date picker
+    if (focusedCell.getAttribute('data-inline-type') === 'date') {
+      dispatch({
+        type: 'EXIT_EDIT_MODE',
+        payload: activeCellId
+      });
+      var inlineEditArea = document.querySelector("#".concat(instance.tableId, " .").concat(blockClass, "__table-with-inline-edit"));
+      inlineEditArea.focus();
+    }
+    event.preventDefault();
+    return;
+  }
+  if (activeCellId === editId && key === 'Escape') {
+    if (focusedCell.getAttribute('data-inline-type') === 'date') {
+      dispatch({
+        type: 'EXIT_EDIT_MODE',
+        payload: activeCellId
+      });
+      event.preventDefault();
+      var _inlineEditArea = document.querySelector("#".concat(instance.tableId, " .").concat(blockClass, "__table-with-inline-edit"));
+      _inlineEditArea.focus();
+      return;
+    }
+  }
+
+  // Checks if the dropdown menu is open
+  var dropdownIsActive = function dropdownIsActive() {
+    var focusedElementRole = document.activeElement.getAttribute('role');
+    if (focusedElementRole === 'listbox' && document.activeElement.classList.contains("".concat(carbon.prefix, "--list-box__menu"))) {
+      // Prevents arrow keys from scrolling any other content when dropdown menu is open
+      event.preventDefault();
+      return true;
+    }
+    return false;
+  };
+
+  // Checks if the date picker is open
+  var datePickerIsActive = function datePickerIsActive() {
+    var focusedCalendarElement = document.querySelector(".".concat(carbon.prefix, "--date-picker__input.flatpickr-input.active"));
+    if (focusedCalendarElement || document.activeElement.classList.contains("flatpickr-day")) {
+      return true;
+    }
+    return false;
+  };
+
+  // Stop grid key listener when in edit mode
+  var isEditing = document.activeElement.id === activeCellId && document.activeElement.id === editId || dropdownIsActive() || datePickerIsActive();
+  if (isEditing || !gridActive) {
+    return;
+  }
+  // Command keys need to be returned as there is default browser behavior with these keys
+  if (key === 'Meta' || key === 'Control') {
+    return;
+  }
+  // Prevent arrow keys, home key, and end key from scrolling the page when the data spreadsheet container has focus
+  if (['End', 'Home', 'ArrowLeft', 'ArrowUp', 'ArrowRight', 'ArrowDown'].indexOf(key) > -1 && !isEditing && keysPressedList.length < 2) {
+    event.preventDefault();
+  }
+  var isDisabledCell = !!focusedCell.getAttribute('data-disabled');
+  var sharedUpdateParams = {
+    oldId: activeCellId,
+    instance: instance
+  };
+  if (keysPressedList.length > 1) {
+    handleMultipleKeys({
+      usingMac: usingMac,
+      keysPressedList: keysPressedList,
+      dispatch: dispatch,
+      activeCellId: activeCellId,
+      instance: instance
+    });
+  }
+  if (keysPressedList.length < 2) {
+    switch (key) {
+      case 'Tab':
+        {
+          if (!editId) {
+            dispatch({
+              type: 'REMOVE_GRID_ACTIVE_FOCUS',
+              payload: activeCellId
+            });
+          }
+          break;
+        }
+      case 'ArrowRight':
+        {
+          dispatch({
+            type: 'UPDATE_ACTIVE_CELL_ID',
+            payload: _objectSpread({
+              direction: 'right'
+            }, sharedUpdateParams)
+          });
+          break;
+        }
+      case 'ArrowLeft':
+        {
+          dispatch({
+            type: 'UPDATE_ACTIVE_CELL_ID',
+            payload: _objectSpread({
+              direction: 'left'
+            }, sharedUpdateParams)
+          });
+          break;
+        }
+      case 'ArrowUp':
+        {
+          dispatch({
+            type: 'UPDATE_ACTIVE_CELL_ID',
+            payload: _objectSpread({
+              direction: 'up'
+            }, sharedUpdateParams)
+          });
+          break;
+        }
+      case 'ArrowDown':
+        {
+          dispatch({
+            type: 'UPDATE_ACTIVE_CELL_ID',
+            payload: _objectSpread({
+              direction: 'down'
+            }, sharedUpdateParams)
+          });
+          break;
+        }
+      // Move active cell to first column in current row
+      case 'Home':
+        {
+          var activeCellObject = getCellIdAsObject(activeCellId);
+          var newActiveCellCoords = _objectSpread(_objectSpread({}, activeCellObject), {}, {
+            column: 0
+          });
+          var newActiveCellId = "column-".concat(newActiveCellCoords.column, "-row-").concat(newActiveCellCoords.row);
+          var scrollElement = document.querySelector("#".concat(instance.tableId, " .").concat(pkg.prefix, "--datagrid__table-container"));
+          // Scroll table container to the furthest left position
+          scrollElement.scrollLeft = 0;
+          dispatch({
+            type: 'UPDATE_ACTIVE_CELL_ID',
+            payload: newActiveCellId
+          });
+          break;
+        }
+      // Move active cell to last column in current row
+      case 'End':
+        {
+          var _activeCellObject = getCellIdAsObject(activeCellId);
+          var totalVisibleColumns = instance.visibleColumns.filter(function (item) {
+            return item.id !== 'spacer';
+          });
+          var _newActiveCellCoords = _objectSpread(_objectSpread({}, _activeCellObject), {}, {
+            column: totalVisibleColumns.length - 1
+          });
+          var _newActiveCellId = "column-".concat(_newActiveCellCoords.column, "-row-").concat(_newActiveCellCoords.row);
+          var _scrollElement = document.querySelector("#".concat(instance.tableId, " .").concat(pkg.prefix, "--datagrid__table-container"));
+          // Scroll table container to the furthest right position
+          _scrollElement.scrollLeft = _scrollElement.scrollWidth;
+          dispatch({
+            type: 'UPDATE_ACTIVE_CELL_ID',
+            payload: _newActiveCellId
+          });
+          break;
+        }
+      case ' ':
+      case 'F2':
+      case 'Enter':
+        {
+          // Disabled cells are not allowed to go into edit mode
+          if (isDisabledCell) {
+            return;
+          }
+          // Only go into edit mode if there is no editId, meaning that we're not already in edit mode
+          if (!editId) {
+            var focusedType = focusedCell.getAttribute('data-inline-type');
+            // Open dropdown immediately after entering edit mode for selection type
+            if (focusedType === 'selection') {
+              setTimeout(function () {
+                var dropdownTrigger = focusedCell.querySelector('button');
+                dropdownTrigger === null || dropdownTrigger === void 0 ? void 0 : dropdownTrigger.click();
+              }, 1);
+            }
+            if (focusedType === 'date') {
+              setTimeout(function () {
+                var dateInputTrigger = focusedCell.querySelector('input');
+                dateInputTrigger === null || dateInputTrigger === void 0 ? void 0 : dateInputTrigger.click();
+                dateInputTrigger === null || dateInputTrigger === void 0 ? void 0 : dateInputTrigger.focus();
+              }, 1);
+            }
+            dispatch({
+              type: 'ENTER_EDIT_MODE',
+              payload: {
+                activeCellId: activeCellId,
+                editId: activeCellId
+              }
+            });
+          }
+        }
+    }
+  }
+};

package/es/components/Datagrid/Datagrid/addons/InlineEdit/handleMultipleKeys.js

@@ -0,0 +1,80 @@
+/**
+ * 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 { includesResourceKey } from '../../../../DataSpreadsheet/utils/handleMultipleKeys';
+import { pkg } from '../../../../../settings';
+import { getFocusableElements } from '../../../../../global/js/utils/getFocusableElements';
+var blockClass = "".concat(pkg.prefix, "--datagrid");
+export var handleMultipleKeys = function handleMultipleKeys(_ref) {
+  var usingMac = _ref.usingMac,
+    keysPressedList = _ref.keysPressedList,
+    dispatch = _ref.dispatch,
+    activeCellId = _ref.activeCellId,
+    instance = _ref.instance;
+  // Resource key and Home
+  // Move active cell to first cell in first row and column
+  if (includesResourceKey(keysPressedList, usingMac) && keysPressedList.includes('Home')) {
+    var scrollElement = document.querySelector("#".concat(instance.tableId, " .").concat(pkg.prefix, "--datagrid__table-container"));
+    // Scroll table container to the furthest top left position
+    scrollElement.scrollTop = 0;
+    scrollElement.scrollLeft = 0;
+    dispatch({
+      type: 'UPDATE_ACTIVE_CELL_ID',
+      payload: 'column-0-row-0'
+    });
+  }
+
+  // Resource key and End
+  // Move active cell to last cell in in the last row and column
+  if (includesResourceKey(keysPressedList, usingMac) && keysPressedList.includes('End')) {
+    var _instance$rows;
+    var totalVisibleColumns = instance.visibleColumns.filter(function (item) {
+      return item.id !== 'spacer';
+    }).length;
+    var totalRows = (_instance$rows = instance.rows) === null || _instance$rows === void 0 ? void 0 : _instance$rows.length;
+    var lastCellDataId = "column-".concat(totalVisibleColumns - 1, "-row-").concat(totalRows - 1);
+    var lastCellElement = document.querySelector("#".concat(instance.tableId, " .").concat(blockClass, "__table-with-inline-edit [data-cell-id=\"").concat(activeCellId, "\"]"));
+    var _scrollElement = document.querySelector("#".concat(instance.tableId, " .").concat(pkg.prefix, "--datagrid__table-container"));
+    // Scroll table container to the furthest bottom right position
+    _scrollElement.scrollTop = _scrollElement.scrollHeight;
+    _scrollElement.scrollLeft = _scrollElement.scrollWidth;
+    if (lastCellElement) {
+      dispatch({
+        type: 'UPDATE_ACTIVE_CELL_ID',
+        payload: lastCellDataId
+      });
+    } else {
+      // If a Datagrid component is using virtualized data, it's possible that the last cell
+      // has not yet been rendered. In this case, we simply need to wait until the scrollable
+      // container has scrolled to the bottom/right most position, then we can dispatch the
+      // update active cell id action
+      setTimeout(function () {
+        dispatch({
+          type: 'UPDATE_ACTIVE_CELL_ID',
+          payload: lastCellDataId
+        });
+      }, 250);
+    }
+  }
+  // Shift + Tab
+  // This should remove the active grid state
+  if ((keysPressedList.includes('ShiftLeft') || keysPressedList.includes('ShiftRight')) && keysPressedList.includes('Tab')) {
+    dispatch({
+      type: 'REMOVE_GRID_ACTIVE_FOCUS',
+      payload: activeCellId
+    });
+    var tableElement = document.querySelector("#".concat(instance.tableId));
+    var datagridFocusableElements = getFocusableElements(tableElement);
+    var indexOfTable = datagridFocusableElements.findIndex(function (item) {
+      return item instanceof HTMLTableElement;
+    });
+    if (indexOfTable && Number.isFinite(indexOfTable)) {
+      var _datagridFocusableEle;
+      (_datagridFocusableEle = datagridFocusableElements[indexOfTable]) === null || _datagridFocusableEle === void 0 ? void 0 : _datagridFocusableEle.focus();
+    }
+  }
+};

package/es/components/Datagrid/Datagrid/addons/RowSize/RowSizeDropdown.js

@@ -0,0 +1,67 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["align", "legendText"];
+/**
+ * Copyright IBM Corp. 2021, 2023
+ *
+ * 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 * as React from 'react';
+import PropTypes from 'prop-types';
+import { Settings } from '@carbon/react/icons';
+import { IconButton, Toggletip, ToggletipContent, ToggletipButton } from '@carbon/react';
+import cx from 'classnames';
+import RowSizeRadioGroup from './RowSizeRadioGroup';
+import { pkg } from '../../../../../settings';
+var blockClass = "".concat(pkg.prefix, "--datagrid");
+var RowSizeDropdown = function RowSizeDropdown(_ref) {
+  var _ref$align = _ref.align,
+    align = _ref$align === void 0 ? 'bottom' : _ref$align,
+    _ref$legendText = _ref.legendText,
+    legendText = _ref$legendText === void 0 ? 'Row height' : _ref$legendText,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var _React$useState = React.useState(false),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    isOpen = _React$useState2[0],
+    setIsOpen = _React$useState2[1];
+  return /*#__PURE__*/React.createElement(React.Fragment, null, !isOpen && /*#__PURE__*/React.createElement(IconButton, {
+    kind: "ghost",
+    align: align,
+    onClick: function onClick() {
+      return setIsOpen(function (prevOpen) {
+        return !prevOpen;
+      });
+    },
+    label: legendText,
+    className: cx("".concat(blockClass, "__row-size-button"))
+  }, /*#__PURE__*/React.createElement(Settings, {
+    size: 16
+  })), isOpen && /*#__PURE__*/React.createElement(Toggletip, {
+    defaultOpen: true,
+    className: "".concat(blockClass, "__row-size-toggle-tip")
+  }, /*#__PURE__*/React.createElement(ToggletipButton, {
+    className: cx("".concat(blockClass, "__row-size-toggle-tip-button"), "".concat(blockClass, "__row-size-button--open")),
+    label: legendText
+  }, /*#__PURE__*/React.createElement(Settings, {
+    size: 16
+  })), /*#__PURE__*/React.createElement(ToggletipContent, {
+    className: "".concat(blockClass, "__row-size-toggle-tip-content")
+  }, /*#__PURE__*/React.createElement(RowSizeRadioGroup, _extends({}, props, {
+    legendText: legendText,
+    hideRadioGroup: function hideRadioGroup() {
+      setIsOpen(false);
+    }
+  })))));
+};
+RowSizeDropdown.propTypes = {
+  align: IconButton.propTypes.align,
+  datagridName: PropTypes.string,
+  legendText: PropTypes.string,
+  light: PropTypes.bool,
+  onChange: PropTypes.func.isRequired,
+  selectedOption: PropTypes.string
+};
+export default RowSizeDropdown;

package/es/components/Datagrid/Datagrid/addons/RowSize/RowSizeRadioGroup.js

@@ -0,0 +1,105 @@
+/* eslint-disable react/default-props-match-prop-types */
+// @flow
+/*
+ * Licensed Materials - Property of IBM
+ * 5724-Q36
+ * (c) Copyright IBM Corp. 2021
+ * US Government Users Restricted Rights - Use, duplication or disclosure
+ * restricted by GSA ADP Schedule Contract with IBM Corp.
+ */
+
+import React, { useRef } from 'react';
+import PropTypes from 'prop-types';
+import { RadioButtonGroup, RadioButton } from '@carbon/react';
+import isArray from 'lodash/isArray';
+import { pkg } from '../../../../../settings';
+import { useClickOutside } from '../../../../../global/js/hooks';
+var blockClass = "".concat(pkg.prefix, "--datagrid");
+var RowSizeRadioGroup = function RowSizeRadioGroup(_ref) {
+  var rowSizes = _ref.rowSizes,
+    selectedOption = _ref.selectedOption,
+    datagridName = _ref.datagridName,
+    onChange = _ref.onChange,
+    hideRadioGroup = _ref.hideRadioGroup,
+    legendText = _ref.legendText,
+    _ref$rowSizeLabels = _ref.rowSizeLabels,
+    rowSizeLabels = _ref$rowSizeLabels === void 0 ? {
+      xl: 'Extra large',
+      lg: 'Large (default)',
+      md: 'Medium',
+      sm: 'Small',
+      xs: 'Extra small'
+    } : _ref$rowSizeLabels;
+  var popoverContentRef = useRef();
+  useClickOutside(popoverContentRef, function (target) {
+    if (target.closest(".".concat(blockClass, "__row-size-button"))) {
+      return;
+    }
+    hideRadioGroup();
+  });
+  return /*#__PURE__*/React.createElement("div", {
+    ref: popoverContentRef,
+    className: "".concat(blockClass, "__row-size-dropdown"),
+    role: "presentation",
+    onClick: function onClick(e) {
+      e.stopPropagation();
+    }
+  }, /*#__PURE__*/React.createElement(RadioButtonGroup, {
+    legendText: legendText,
+    name: "row-height-group",
+    orientation: "vertical",
+    defaultSelected: getBackwardCompatibleRowSize(selectedOption),
+    onChange: onChange
+  }, rowSizes && isArray(rowSizes) && rowSizes.map(function (option) {
+    var labelText;
+    try {
+      labelText = option.labelText || rowSizeLabels[option.value];
+    } catch (e) {
+      labelText = option.value;
+    }
+    return /*#__PURE__*/React.createElement(RadioButton, {
+      className: "".concat(blockClass, "__row-size-radio-button"),
+      key: option.value,
+      labelText: labelText,
+      value: option.value,
+      id: "".concat(datagridName || 'datagrid', "--row-density--").concat(option.value)
+    });
+  })));
+};
+var getBackwardCompatibleRowSize = function getBackwardCompatibleRowSize(rowSize) {
+  // TODO: deprecate this function in next major release (v8) on carbon-components-react
+  var rowSizeMap = {
+    tall: 'xl',
+    normal: 'lg',
+    short: 'sm',
+    compact: 'xs'
+    // md is a new value
+  };
+
+  return rowSizeMap[rowSize] || rowSize;
+};
+RowSizeRadioGroup.defaultProps = {
+  rowSizes: [{
+    value: 'xl' // 64
+  }, {
+    value: 'lg' // 48
+  }, {
+    value: 'md' // 40
+  }, {
+    value: 'sm' // 32
+  }, {
+    value: 'xs' // 24
+  }],
+
+  selectedOption: 'lg'
+};
+RowSizeRadioGroup.propTypes = {
+  datagridName: PropTypes.string,
+  hideRadioGroup: PropTypes.func.isRequired,
+  legendText: PropTypes.string,
+  onChange: PropTypes.func.isRequired,
+  rowSizeLabels: PropTypes.object,
+  rowSizes: PropTypes.array.isRequired,
+  selectedOption: PropTypes.string.isRequired
+};
+export default RowSizeRadioGroup;

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

@@ -0,0 +1,9 @@
+/*
+ * Licensed Materials - Property of IBM
+ * 5724-Q36
+ * (c) Copyright IBM Corp. 2021
+ * US Government Users Restricted Rights - Use, duplication or disclosure
+ * restricted by GSA ADP Schedule Contract with IBM Corp.
+ */
+
+export { default as RowSizeDropdown } from './RowSizeDropdown';

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

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { Datagrid } from './Datagrid';

package/es/components/Datagrid/Datagrid.stories/CustomizeColumnStory.js

@@ -0,0 +1,6 @@
+var notes = "\n  # Customizing columns\n  Customizing columns allows user to reorder and hide certain columns of the datagrid. Consuming component can use the provided callback to save/update according to their persistent strategy.\n\n  ## Documentation:\n\n  - (required) Add following plugins to `useDatagrid` hook\n    - `useCustomizeColumns`\n    - `useColumnOrder`\n  - (required) Implement `options.DatagridActions` component\n    - this component will have props: `datagridState`\n    - render `datagridState.CustomizeColumnsButton` component wherever makes sense.\n    - `CustomizeColumnsButton` props can be overridden. Available props: [carbon-components-react doc](https://react.carbondesignsystem.com/?path=/docs/components-button--default)\n  - (optional) Preserve and apply the user preference\n    - `options.initialState.hiddenColumns: Array<ColumnId: String>`\n      - Array of column ids that will be hidden after initial render\n      - [react-table doc](https://react-table.tanstack.com/docs/api/useTable#table-options)\n    - `options.initialState.columnOrder: Array<ColumnId: String>`\n      - Order of the columns. Any column ids not in this array will be ordered by their position in the `options.columns`\n      - [react-table doc](https://react-table.tanstack.com/docs/api/useColumnOrder#table-options)\n    - `options.customizeColumnsProps.onSaveColumnPrefs`\n      - type: `Function(Columns: Array<{ColumnId: String, isVisible: Boolean}>) => void`\n      - It's a callback function when 'Save' button clicked on the modal. It allows consumer to preserve the updated column preference. This output can also be used to compute the `hiddenColumns` and `columnOrder`\n  - (optional) Reset to default\n    - There is a reset to default button on the modal. It will use the `options.columns` as the default. If there are columns should be hidden by default, denote them with property: `isVisible: false` (undefined will be treated as `true`)\n\n  code snippet:\n\n  ```js\n  const columns = React.useMemo(() => defaultHeader, []);\n  const [data] = useState(makeData(10));\n  const DatagridActions = (datagridState) => (\n    <TableToolbarContent>\n      <TableToolbarSearch ... />\n      <Button ... />\n      <datagridState.CustomizeColumnsButton />\n    </TableToolbarContent>\n  )\n  const datagridState = useDatagrid(\n    {\n      columns,\n      data,\n      initialState: {\n        hiddenColumns: ['age'],\n        columnOrder: [],\n      },\n      customizeColumnsProps: {\n        onSaveColumnPrefs: (newColDefs) => {\n          console.log(newColDefs);\n        },\n      },\n      DatagridActions,\n    },\n    useCustomizeColumns,\n    useColumnOrder,\n  );\n\n  return (\n    <Wrapper>\n      <IntlProvider locale=\"en\">\n        <Datagrid {...datagridState} />\n        <div>\n          Hidden column ids: \n          <pre>{JSON.stringify(datagridState.state.hiddenColumns, null, 2)}</pre>\n        </div>\n      </IntlProvider>\n    </Wrapper>\n  );\n  ```\n";
+export var story = {
+  parameters: {
+    notes: notes
+  }
+};

package/es/components/Datagrid/Datagrid.stories/RowSizeDropdownStory.js

@@ -0,0 +1,6 @@
+var notes = "\n# Changing row size (height/density)\nAllow users to adjust the data density on datagrid.\n\n## Documentation:\n\n- (optional) Define initial row size by `datagridOptions.rowSize`.\n  - Default value is `md`.\n  - Supported values are `xl`, `lg`, `md`, `sm`, `xs` same as size prop on carbon component react `DataTable`.\n- (optional) Provide list of allowed sizes use `datagridOptions.rowSizes`\n  - Default list is\n    ```\n      [{ value: 'lg'}, { value: 'md'}, {value: 'sm'}, {value: 'xs'}]\n    ```\n  - Provide `labelText` in each option if not satisfied with the default labels.\n- (optional) Use `RowSizeDropdown` component to change row size:\n  - (required) Implement `datagridOptions.DatagridActions` component\n    - The component will have props: `datagridState`\n    - Render `datagridState.RowSizeDropdown` component in `datagridOptions.DatagridActions`.\n      - Pass `datagridState.rowSizeDropdownProps` as props\n      - No extra logic is needed.\n  - (optional) Preserve row size, use `datagridOptions.onRowSizeChange`\n    - type: `Function(rowSize: String) => void`\n    - It's a callback function when different row size option is selected on the dropdown.\n- (optional) Use other component to change row size:\n  - Wire the variable controlled by the component with `datagridOptions.rowSize = variable`\n- (optional) Render different content in the cell on different `rowSize`\n  - `Cell` renderer of each column will receive `datagridState` which will contain `rowSize`. Render different content based on this value.\n\ncode snippet:\n\n```js\nconst columns = React.useMemo(() => [ ...defaultHeader.slice(0, 3),\n  {\n    Header: 'Different cell content',\n    id: 'rowSizeDemo-cell',\n    disableSortBy: true,\n    Cell: ({ rowSize }) => rowSize,\n  }\n], []);\nconst [data] = useState(makeData(10));\nconst DatagridActions = (datagridState) => (\n  <TableToolbarContent>\n    <TableToolbarSearch ... />\n    <Button ... />\n    <datagridState.RowSizeDropdown {...datagridState.rowSizeDropdownProps} />\n  </TableToolbarContent>\n)\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    rowSize: 'xs',\n    rowSizes: [\n      {\n        value: 'lg',\n        labelText: 'Super tall row',\n      },\n      {\n        value: 'md',\n      },\n      {\n        value: 'xs',\n        labelText: 'Teeny tiny row',\n      },\n    ],\n    onRowSizeChange: (rowSize) => {\n      console.log(rowSize);\n    },\n    DatagridActions,\n  },\n);\n\nreturn (\n  <Wrapper>\n    <IntlProvider locale=\"en\">\n      <Datagrid {...datagridState} />\n    </IntlProvider>\n  </Wrapper>\n);\n```\n";
+export var story = {
+  parameters: {
+    notes: notes
+  }
+};

package/es/components/Datagrid/Datagrid.stories/SelectAllWithToggleStory.js

@@ -0,0 +1,6 @@
+var notes = "\n# Select all toggle\nUse this feature will allow user to toggle the select all checkbox behavior between selecting all rows **on current page** vs **across all pages**\n<br/>\nIt's using [react-table API](https://react-table.tanstack.com/docs/api/useRowSelect#instance-properties) to select all rows.\n\n## Terminology\n- Pagination\n  - **UI side pagination**: all rows are loaded to browser, but only display subset of them.\n  - **Server side pagination**: subset of rows are loaded to browser, going to another page requires another network call\n- Selection mode\n  - **all rows**: selects all rows across pages.\n  - **all page rows**: selects all rows on the current page.\n\n## Compatibility with other plugin hooks and options\n- It has to be used with `useSelectRows` hook.\n- Select all toggle will not be enabled if `options.DatagridPagination` is not defined (select all is the same without pagination)\n- Compatible with `options.DatagridBatchActions`\n- Obviously it will not work when select-all is hidden by `options.hideSelectAll`.\n- Not compatible with `useInfiniteScroll`. Pull request welcome!\n\n## Sample usage:\n- (required) `useSelectRows` - enable row selections with select all on header\n- (required) `useSelectAllToggle` - enable select all toggle.\n- (optional) config the label on toggle menu:\n  - (optional) `options.selectAllToggle.labels.allRows` for label that selects all rows across all pages\n  - (optional) `options.selectAllToggle.labels.allPageRows` for label that selects all rows on current page\n- (optional) `options.selectAllToggle.onSelectAllRows`\n  - type: `Function(areAllRowsSelected: Boolean) => void`\n  - callback when `instance.isAllRowsSelected` value changes. Check out doc: [instance property](https://react-table.tanstack.com/docs/api/useRowSelect#instance-properties)\n    - `true`: when selection mode is **all rows** and user selects all via toggle dropdown 'Select all' or toggle 'on' on the select all checkbox.\n  - useful when grid is server side paginated (only a subset of rows are loaded in UI)\n\n```js\nconst columns = React.useMemo(() => defaultHeader, []);\n  const [data] = useState(makeData(100));\n  const datagridState = useDatagrid(\n    {\n      columns,\n      data,\n      initialState: {\n        pageSize: 10,\n        pageSizes: [5,10,25,50]\n      },\n      selectAllToggle: {\n        labels: {\n          allRows: \"Select all randomly generated rows\",\n        },\n        onSelectAllRows: (areAllSelected) => console.log('are all selected: ', areAllSelected),\n      },\n      DatagridPagination,\n      DatagridActions,\n      DatagridBatchActions,\n    },\n    useSelectRows,\n    useSelectAllToggle,\n  );\n\n  return (\n    <Wrapper>\n      <Datagrid {...datagridState} />\n    </Wrapper>\n);\n```\n\n";
+export var story = {
+  parameters: {
+    notes: notes
+  }
+};

package/es/components/Datagrid/Datagrid.stories/StickyActionsColumnStory.js

@@ -0,0 +1,102 @@
+// import React, { useState, useEffect } from 'react';
+// import { Datagrid, useActionsColumn, useDatagrid, useStickyColumn } from '..';
+// import { defaultHeader, makeData, Wrapper } from './common';
+
+// StickyActionsColumn.story = {
+//   parameters: {
+//     notes: `
+//     Sticky column and actions column can be used at the same time like the demo above. Following is the doc for each of them.
+
+//     # Sticky column
+//     This will make the column mark with \`sticky: "right"\` to be sticky on the right.
+
+//     ## Incompatible with following plugins:
+//     - \`useInfiniteScroll\`
+
+//     ## Sample usage:
+
+//     1. include the \`useStickyColumn\` hook
+//     2. add \`sticky="right"\` to the column object
+
+//     \`\`\`js
+//     const columns = [
+//       ... // other columns
+//       {
+//         Header: "",
+//         accessor: "actions",
+//         sticky: "right",
+//         width: 60,
+//       },
+//     ]
+//     const datagridState = useDatagrid(
+//       {
+//         columns,
+//         data,
+//       },
+//       useStickyColumn
+//     );
+//     \`\`\`
+//     \`\`\`html
+//     <Datagrid {...datagridState} />
+//     \`\`\`
+
+//     # Actions column
+//     This will add OverflowMenu component to the cells on the column mark with \`isAction: true\`. Each action button callback will include the actionId and row object
+
+//     ## Sample usage:
+//     1. include \`useActionsColumn\` hook
+//     2. add \`isAction = true\` to the column object in which you which to add the overflow menu actions
+//     3. add \`rowActions = []\` array to the props
+//       - \`rowActions[].id\` for callback to identify the action is called
+//       - \`rowActions[].onClick(actionId: string, row: Row, event: ClickEvent)\` callback on menuitem clicked. [Row properties](https://react-table.tanstack.com/docs/api/useTable#row-properties)
+//       - \`rowActions[].shouldHideMenuItem(row: Row)\` callback to hide this menuitem. [Row properties](https://react-table.tanstack.com/docs/api/useTable#row-properties)
+//       - \`rowActions[].shouldDisableMenuItem(row: Row)\` callback to disable this menuitem. [Row properties](https://react-table.tanstack.com/docs/api/useTable#row-properties)
+//         - This will override \`rowActions[].disabled\` (from Carbon) because \`shouldDisableMenuItem\` is more specific to the row.
+//       - each action object can take all the props from \`OverflowMenuItem\` props, see [carbon docs](https://react.carbondesignsystem.com/?path=/docs/components-overflowmenu--default#overflowmenu)
+
+//     \`\`\`js
+//     const columns = [
+//       ... // other columns
+//       {
+//         Header: "",
+//         accessor: "actions",
+//         isAction: true,
+//       },
+//     ]
+//     const onActionClick = (actionId, row, event) => {};
+//     const datagridState = useDatagrid(
+//       {
+//         columns,
+//         data,
+//         rowActions: [
+//           {
+//             id: 'edit',
+//             itemText: 'Edit',
+//             onClick: onActionClick
+//           },
+//           {
+//             id: 'hidden',
+//             itemText: 'Hidden item',
+//             onClick: onActionClick,
+//             shouldHideMenuItem: () => true,
+//           },
+//           {
+//             id: 'delete',
+//             itemText: 'Delete',
+//             hasDivider: true,
+//             isDelete: true,
+//             onClick: onActionClick
+//           },
+//         ]
+//       },
+//       useActionsColumn,
+//     );
+//     \`\`\`
+//     \`\`\`html
+//     <Datagrid {...datagridState} />
+//     \`\`\`
+//     `,
+//   },
+// };
+
+// export default StickyActionsColumn;