@mui/x-data-grid 8.0.0-alpha.8 → 8.0.0-beta.0

package/node/hooks/features/rows/useGridRowsPreProcessors.js

@@ -1,89 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useGridRowsPreProcessors = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var _strategyProcessing = require("../../core/strategyProcessing");
-var _gridRowsUtils = require("./gridRowsUtils");
-const createFlatRowTree = rows => {
-  const tree = {
-    [_gridRowsUtils.GRID_ROOT_GROUP_ID]: (0, _extends2.default)({}, (0, _gridRowsUtils.buildRootGroup)(), {
-      children: rows
-    })
-  };
-  for (let i = 0; i < rows.length; i += 1) {
-    const rowId = rows[i];
-    tree[rowId] = {
-      id: rowId,
-      depth: 0,
-      parent: _gridRowsUtils.GRID_ROOT_GROUP_ID,
-      type: 'leaf',
-      groupingKey: null
-    };
-  }
-  return {
-    groupingName: _strategyProcessing.GRID_DEFAULT_STRATEGY,
-    tree,
-    treeDepths: {
-      0: rows.length
-    },
-    dataRowIds: rows
-  };
-};
-const updateFlatRowTree = ({
-  previousTree,
-  actions
-}) => {
-  const tree = (0, _extends2.default)({}, previousTree);
-  const idsToRemoveFromRootGroup = {};
-  for (let i = 0; i < actions.remove.length; i += 1) {
-    const idToDelete = actions.remove[i];
-    idsToRemoveFromRootGroup[idToDelete] = true;
-    delete tree[idToDelete];
-  }
-  for (let i = 0; i < actions.insert.length; i += 1) {
-    const idToInsert = actions.insert[i];
-    tree[idToInsert] = {
-      id: idToInsert,
-      depth: 0,
-      parent: _gridRowsUtils.GRID_ROOT_GROUP_ID,
-      type: 'leaf',
-      groupingKey: null
-    };
-  }
-
-  // TODO rows v6: Support row unpinning
-
-  const rootGroup = tree[_gridRowsUtils.GRID_ROOT_GROUP_ID];
-  let rootGroupChildren = [...rootGroup.children, ...actions.insert];
-  if (Object.values(idsToRemoveFromRootGroup).length) {
-    rootGroupChildren = rootGroupChildren.filter(id => !idsToRemoveFromRootGroup[id]);
-  }
-  tree[_gridRowsUtils.GRID_ROOT_GROUP_ID] = (0, _extends2.default)({}, rootGroup, {
-    children: rootGroupChildren
-  });
-  return {
-    groupingName: _strategyProcessing.GRID_DEFAULT_STRATEGY,
-    tree,
-    treeDepths: {
-      0: rootGroupChildren.length
-    },
-    dataRowIds: rootGroupChildren
-  };
-};
-const flatRowTreeCreationMethod = params => {
-  if (params.updates.type === 'full') {
-    return createFlatRowTree(params.updates.rows);
-  }
-  return updateFlatRowTree({
-    previousTree: params.previousTree,
-    actions: params.updates.actions
-  });
-};
-const useGridRowsPreProcessors = apiRef => {
-  (0, _strategyProcessing.useGridRegisterStrategyProcessor)(apiRef, _strategyProcessing.GRID_DEFAULT_STRATEGY, 'rowTreeCreation', flatRowTreeCreationMethod);
-};
-exports.useGridRowsPreProcessors = useGridRowsPreProcessors;

package/node/hooks/features/scroll/useGridScroll.js

@@ -1,141 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useGridScroll = void 0;
-var React = _interopRequireWildcard(require("react"));
-var _RtlProvider = require("@mui/system/RtlProvider");
-var _useGridLogger = require("../../utils/useGridLogger");
-var _gridColumnsSelector = require("../columns/gridColumnsSelector");
-var _useGridSelector = require("../../utils/useGridSelector");
-var _gridPaginationSelector = require("../pagination/gridPaginationSelector");
-var _gridRowsSelector = require("../rows/gridRowsSelector");
-var _gridRowsMetaSelector = require("../rows/gridRowsMetaSelector");
-var _useGridApiMethod = require("../../utils/useGridApiMethod");
-var _gridFilterSelector = require("../filter/gridFilterSelector");
-var _dimensions = require("../dimensions");
-var _gridListViewSelectors = require("../listView/gridListViewSelectors");
-// Logic copied from https://www.w3.org/TR/wai-aria-practices/examples/listbox/js/listbox.js
-// Similar to https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
-function scrollIntoView(dimensions) {
-  const {
-    containerSize,
-    scrollPosition,
-    elementSize,
-    elementOffset
-  } = dimensions;
-  const elementEnd = elementOffset + elementSize;
-  // Always scroll to top when cell is higher than viewport to avoid scroll jump
-  // See https://github.com/mui/mui-x/issues/4513 and https://github.com/mui/mui-x/issues/4514
-  if (elementSize > containerSize) {
-    return elementOffset;
-  }
-  if (elementEnd - containerSize > scrollPosition) {
-    return elementEnd - containerSize;
-  }
-  if (elementOffset < scrollPosition) {
-    return elementOffset;
-  }
-  return undefined;
-}
-
-/**
- * @requires useGridPagination (state) - can be after, async only
- * @requires useGridColumns (state) - can be after, async only
- * @requires useGridRows (state) - can be after, async only
- * @requires useGridRowsMeta (state) - can be after, async only
- * @requires useGridFilter (state)
- * @requires useGridColumnSpanning (method)
- */
-const useGridScroll = (apiRef, props) => {
-  const isRtl = (0, _RtlProvider.useRtl)();
-  const logger = (0, _useGridLogger.useGridLogger)(apiRef, 'useGridScroll');
-  const colRef = apiRef.current.columnHeadersContainerRef;
-  const virtualScrollerRef = apiRef.current.virtualScrollerRef;
-  const visibleSortedRows = (0, _useGridSelector.useGridSelector)(apiRef, _gridFilterSelector.gridExpandedSortedRowEntriesSelector);
-  const scrollToIndexes = React.useCallback(params => {
-    const dimensions = (0, _dimensions.gridDimensionsSelector)(apiRef.current.state);
-    const totalRowCount = (0, _gridRowsSelector.gridRowCountSelector)(apiRef);
-    const visibleColumns = props.unstable_listView ? [(0, _gridListViewSelectors.gridListColumnSelector)(apiRef.current.state)] : (0, _gridColumnsSelector.gridVisibleColumnDefinitionsSelector)(apiRef);
-    const scrollToHeader = params.rowIndex == null;
-    if (!scrollToHeader && totalRowCount === 0 || visibleColumns.length === 0) {
-      return false;
-    }
-    logger.debug(`Scrolling to cell at row ${params.rowIndex}, col: ${params.colIndex} `);
-    let scrollCoordinates = {};
-    if (params.colIndex !== undefined) {
-      const columnPositions = (0, _gridColumnsSelector.gridColumnPositionsSelector)(apiRef);
-      let cellWidth;
-      if (typeof params.rowIndex !== 'undefined') {
-        const rowId = visibleSortedRows[params.rowIndex]?.id;
-        const cellColSpanInfo = apiRef.current.unstable_getCellColSpanInfo(rowId, params.colIndex);
-        if (cellColSpanInfo && !cellColSpanInfo.spannedByColSpan) {
-          cellWidth = cellColSpanInfo.cellProps.width;
-        }
-      }
-      if (typeof cellWidth === 'undefined') {
-        cellWidth = visibleColumns[params.colIndex].computedWidth;
-      }
-      // When using RTL, `scrollLeft` becomes negative, so we must ensure that we only compare values.
-      scrollCoordinates.left = scrollIntoView({
-        containerSize: dimensions.viewportOuterSize.width,
-        scrollPosition: Math.abs(virtualScrollerRef.current.scrollLeft),
-        elementSize: cellWidth,
-        elementOffset: columnPositions[params.colIndex]
-      });
-    }
-    if (params.rowIndex !== undefined) {
-      const rowsMeta = (0, _gridRowsMetaSelector.gridRowsMetaSelector)(apiRef.current.state);
-      const page = (0, _gridPaginationSelector.gridPageSelector)(apiRef);
-      const pageSize = (0, _gridPaginationSelector.gridPageSizeSelector)(apiRef);
-      const elementIndex = !props.pagination ? params.rowIndex : params.rowIndex - page * pageSize;
-      const targetOffsetHeight = rowsMeta.positions[elementIndex + 1] ? rowsMeta.positions[elementIndex + 1] - rowsMeta.positions[elementIndex] : rowsMeta.currentPageTotalHeight - rowsMeta.positions[elementIndex];
-      scrollCoordinates.top = scrollIntoView({
-        containerSize: dimensions.viewportInnerSize.height,
-        scrollPosition: virtualScrollerRef.current.scrollTop,
-        elementSize: targetOffsetHeight,
-        elementOffset: rowsMeta.positions[elementIndex]
-      });
-    }
-    scrollCoordinates = apiRef.current.unstable_applyPipeProcessors('scrollToIndexes', scrollCoordinates, params);
-    if (typeof scrollCoordinates.left !== undefined || typeof scrollCoordinates.top !== undefined) {
-      apiRef.current.scroll(scrollCoordinates);
-      return true;
-    }
-    return false;
-  }, [logger, apiRef, virtualScrollerRef, props.pagination, visibleSortedRows, props.unstable_listView]);
-  const scroll = React.useCallback(params => {
-    if (virtualScrollerRef.current && params.left !== undefined && colRef.current) {
-      const direction = isRtl ? -1 : 1;
-      colRef.current.scrollLeft = params.left;
-      virtualScrollerRef.current.scrollLeft = direction * params.left;
-      logger.debug(`Scrolling left: ${params.left}`);
-    }
-    if (virtualScrollerRef.current && params.top !== undefined) {
-      virtualScrollerRef.current.scrollTop = params.top;
-      logger.debug(`Scrolling top: ${params.top}`);
-    }
-    logger.debug(`Scrolling, updating container, and viewport`);
-  }, [virtualScrollerRef, isRtl, colRef, logger]);
-  const getScrollPosition = React.useCallback(() => {
-    if (!virtualScrollerRef?.current) {
-      return {
-        top: 0,
-        left: 0
-      };
-    }
-    return {
-      top: virtualScrollerRef.current.scrollTop,
-      left: virtualScrollerRef.current.scrollLeft
-    };
-  }, [virtualScrollerRef]);
-  const scrollApi = {
-    scroll,
-    scrollToIndexes,
-    getScrollPosition
-  };
-  (0, _useGridApiMethod.useGridApiMethod)(apiRef, scrollApi, 'public');
-};
-exports.useGridScroll = useGridScroll;

package/node/hooks/features/sorting/gridSortingSelector.js

@@ -1,75 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.gridSortedRowIndexLookupSelector = exports.gridSortedRowIdsSelector = exports.gridSortedRowEntriesSelector = exports.gridSortModelSelector = exports.gridSortColumnLookupSelector = void 0;
-var _createSelector = require("../../../utils/createSelector");
-var _gridRowsSelector = require("../rows/gridRowsSelector");
-var _gridRowsUtils = require("../rows/gridRowsUtils");
-/**
- * @category Sorting
- * @ignore - do not document.
- */
-const gridSortingStateSelector = state => state.sorting;
-
-/**
- * Get the id of the rows after the sorting process.
- * @category Sorting
- */
-const gridSortedRowIdsSelector = exports.gridSortedRowIdsSelector = (0, _createSelector.createSelector)(gridSortingStateSelector, sortingState => sortingState.sortedRows);
-
-/**
- * Get the id and the model of the rows after the sorting process.
- * @category Sorting
- */
-const gridSortedRowEntriesSelector = exports.gridSortedRowEntriesSelector = (0, _createSelector.createSelectorMemoized)(gridSortedRowIdsSelector, _gridRowsSelector.gridRowsLookupSelector, _gridRowsSelector.gridRowTreeSelector, (sortedIds, idRowsLookup, rowTree) => sortedIds.reduce((acc, id) => {
-  const model = idRowsLookup[id];
-  if (model) {
-    acc.push({
-      id,
-      model
-    });
-  }
-  const rowNode = rowTree[id];
-  if (rowNode && (0, _gridRowsUtils.isAutogeneratedRowNode)(rowNode)) {
-    acc.push({
-      id,
-      model: {
-        [_gridRowsUtils.GRID_ID_AUTOGENERATED]: id
-      }
-    });
-  }
-  return acc;
-}, []));
-
-/**
- * Get the current sorting model.
- * @category Sorting
- */
-const gridSortModelSelector = exports.gridSortModelSelector = (0, _createSelector.createSelector)(gridSortingStateSelector, sorting => sorting.sortModel);
-/**
- * @category Sorting
- * @ignore - do not document.
- */
-const gridSortColumnLookupSelector = exports.gridSortColumnLookupSelector = (0, _createSelector.createSelectorMemoized)(gridSortModelSelector, sortModel => {
-  const result = sortModel.reduce((res, sortItem, index) => {
-    res[sortItem.field] = {
-      sortDirection: sortItem.sort,
-      sortIndex: sortModel.length > 1 ? index + 1 : undefined
-    };
-    return res;
-  }, {});
-  return result;
-});
-
-/**
- * @category Sorting
- * @ignore - do not document.
- */
-const gridSortedRowIndexLookupSelector = exports.gridSortedRowIndexLookupSelector = (0, _createSelector.createSelectorMemoized)(gridSortedRowIdsSelector, sortedIds => {
-  return sortedIds.reduce((acc, id, index) => {
-    acc[id] = index;
-    return acc;
-  }, Object.create(null));
-});

package/node/hooks/features/sorting/gridSortingState.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/node/hooks/features/sorting/gridSortingUtils.js

@@ -1,151 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.sanitizeSortModel = exports.mergeStateWithSortModel = exports.gridStringOrNumberComparator = exports.gridNumberComparator = exports.gridDateComparator = exports.getNextGridSortDirection = exports.buildAggregatedSortingApplier = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var _warning = require("@mui/x-internals/warning");
-const sanitizeSortModel = (model, disableMultipleColumnsSorting) => {
-  if (disableMultipleColumnsSorting && model.length > 1) {
-    if (process.env.NODE_ENV !== 'production') {
-      (0, _warning.warnOnce)(['MUI X: The `sortModel` can only contain a single item when the `disableMultipleColumnsSorting` prop is set to `true`.', 'If you are using the community version of the Data Grid, this prop is always `true`.'], 'error');
-    }
-    return [model[0]];
-  }
-  return model;
-};
-exports.sanitizeSortModel = sanitizeSortModel;
-const mergeStateWithSortModel = (sortModel, disableMultipleColumnsSorting) => state => (0, _extends2.default)({}, state, {
-  sorting: (0, _extends2.default)({}, state.sorting, {
-    sortModel: sanitizeSortModel(sortModel, disableMultipleColumnsSorting)
-  })
-});
-exports.mergeStateWithSortModel = mergeStateWithSortModel;
-const isDesc = direction => direction === 'desc';
-
-/**
- * Transform an item of the sorting model into a method comparing two rows.
- * @param {GridSortItem} sortItem The sort item we want to apply.
- * @param {React.RefObject<GridApiCommunity>} apiRef The API of the grid.
- * @returns {GridParsedSortItem | null} The parsed sort item. Returns `null` is the sort item is not valid.
- */
-const parseSortItem = (sortItem, apiRef) => {
-  const column = apiRef.current.getColumn(sortItem.field);
-  if (!column || sortItem.sort === null) {
-    return null;
-  }
-  let comparator;
-  if (column.getSortComparator) {
-    comparator = column.getSortComparator(sortItem.sort);
-  } else {
-    comparator = isDesc(sortItem.sort) ? (...args) => -1 * column.sortComparator(...args) : column.sortComparator;
-  }
-  if (!comparator) {
-    return null;
-  }
-  const getSortCellParams = id => ({
-    id,
-    field: column.field,
-    rowNode: apiRef.current.getRowNode(id),
-    value: apiRef.current.getCellValue(id, column.field),
-    api: apiRef.current
-  });
-  return {
-    getSortCellParams,
-    comparator
-  };
-};
-/**
- * Compare two rows according to a list of valid sort items.
- * The `row1Params` and `row2Params` must have the same length as `parsedSortItems`,
- * and each of their index must contain the `GridSortCellParams` of the sort item with the same index.
- * @param {GridParsedSortItem[]} parsedSortItems All the sort items with which we want to compare the rows.
- * @param {GridRowAggregatedSortingParams} row1 The node and params of the 1st row for each sort item.
- * @param {GridRowAggregatedSortingParams} row2 The node and params of the 2nd row for each sort item.
- */
-const compareRows = (parsedSortItems, row1, row2) => {
-  return parsedSortItems.reduce((res, item, index) => {
-    if (res !== 0) {
-      // return the results of the first comparator which distinguish the two rows
-      return res;
-    }
-    const sortCellParams1 = row1.params[index];
-    const sortCellParams2 = row2.params[index];
-    res = item.comparator(sortCellParams1.value, sortCellParams2.value, sortCellParams1, sortCellParams2);
-    return res;
-  }, 0);
-};
-
-/**
- * Generates a method to easily sort a list of rows according to the current sort model.
- * @param {GridSortModel} sortModel The model with which we want to sort the rows.
- * @param {React.RefObject<GridApiCommunity>} apiRef The API of the grid.
- * @returns {GridSortingModelApplier | null} A method that generates a list of sorted row ids from a list of rows according to the current sort model. If `null`, we consider that the rows should remain in the order there were provided.
- */
-const buildAggregatedSortingApplier = (sortModel, apiRef) => {
-  const comparatorList = sortModel.map(item => parseSortItem(item, apiRef)).filter(comparator => !!comparator);
-  if (comparatorList.length === 0) {
-    return null;
-  }
-  return rowList => rowList.map(node => ({
-    node,
-    params: comparatorList.map(el => el.getSortCellParams(node.id))
-  })).sort((a, b) => compareRows(comparatorList, a, b)).map(row => row.node.id);
-};
-exports.buildAggregatedSortingApplier = buildAggregatedSortingApplier;
-const getNextGridSortDirection = (sortingOrder, current) => {
-  const currentIdx = sortingOrder.indexOf(current);
-  if (!current || currentIdx === -1 || currentIdx + 1 === sortingOrder.length) {
-    return sortingOrder[0];
-  }
-  return sortingOrder[currentIdx + 1];
-};
-exports.getNextGridSortDirection = getNextGridSortDirection;
-const gridNillComparator = (v1, v2) => {
-  if (v1 == null && v2 != null) {
-    return -1;
-  }
-  if (v2 == null && v1 != null) {
-    return 1;
-  }
-  if (v1 == null && v2 == null) {
-    return 0;
-  }
-  return null;
-};
-const collator = new Intl.Collator();
-const gridStringOrNumberComparator = (value1, value2) => {
-  const nillResult = gridNillComparator(value1, value2);
-  if (nillResult !== null) {
-    return nillResult;
-  }
-  if (typeof value1 === 'string') {
-    return collator.compare(value1.toString(), value2.toString());
-  }
-  return value1 - value2;
-};
-exports.gridStringOrNumberComparator = gridStringOrNumberComparator;
-const gridNumberComparator = (value1, value2) => {
-  const nillResult = gridNillComparator(value1, value2);
-  if (nillResult !== null) {
-    return nillResult;
-  }
-  return Number(value1) - Number(value2);
-};
-exports.gridNumberComparator = gridNumberComparator;
-const gridDateComparator = (value1, value2) => {
-  const nillResult = gridNillComparator(value1, value2);
-  if (nillResult !== null) {
-    return nillResult;
-  }
-  if (value1 > value2) {
-    return 1;
-  }
-  if (value1 < value2) {
-    return -1;
-  }
-  return 0;
-};
-exports.gridDateComparator = gridDateComparator;

package/node/hooks/features/sorting/index.js

@@ -1,49 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "gridDateComparator", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingUtils.gridDateComparator;
-  }
-});
-Object.defineProperty(exports, "gridNumberComparator", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingUtils.gridNumberComparator;
-  }
-});
-Object.defineProperty(exports, "gridSortColumnLookupSelector", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingSelector.gridSortColumnLookupSelector;
-  }
-});
-Object.defineProperty(exports, "gridSortModelSelector", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingSelector.gridSortModelSelector;
-  }
-});
-Object.defineProperty(exports, "gridSortedRowEntriesSelector", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingSelector.gridSortedRowEntriesSelector;
-  }
-});
-Object.defineProperty(exports, "gridSortedRowIdsSelector", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingSelector.gridSortedRowIdsSelector;
-  }
-});
-Object.defineProperty(exports, "gridStringOrNumberComparator", {
-  enumerable: true,
-  get: function () {
-    return _gridSortingUtils.gridStringOrNumberComparator;
-  }
-});
-var _gridSortingSelector = require("./gridSortingSelector");
-var _gridSortingUtils = require("./gridSortingUtils");