@mui/x-data-grid 5.4.0 → 5.6.0

package/hooks/utils/useGridInitializeState.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { GridApiCommon } from '../../models/api/gridApiCommon';
+import { GridApiCommunity } from '../../models/api/gridApiCommunity';
+declare type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+export declare type GridStateInitializer<P, Api extends GridApiCommon = GridApiCommunity> = (state: DeepPartial<Api['state']>, props: P, apiRef: React.MutableRefObject<Api>) => DeepPartial<Api['state']>;
+export declare const useGridInitializeState: <P, Api extends GridApiCommon = GridApiCommunity>(initializer: GridStateInitializer<P, Api>, apiRef: React.MutableRefObject<Api>, props: P) => void;
+export {};

package/hooks/utils/useGridInitializeState.js

@@ -0,0 +1,9 @@
+import * as React from 'react';
+export const useGridInitializeState = (initializer, apiRef, props) => {
+  const isInitialized = React.useRef(false);
+
+  if (!isInitialized.current) {
+    apiRef.current.state = initializer(apiRef.current.state, props, apiRef);
+    isInitialized.current = true;
+  }
+};

package/hooks/utils/useGridLogger.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { Logger } from '../../models/logger';
+import { GridApiCommon } from '../../models/api/gridApiCommon';
+export declare function useGridLogger<Api extends GridApiCommon>(apiRef: React.MutableRefObject<Api>, name: string): Logger;

package/hooks/utils/useGridLogger.js

@@ -0,0 +1,12 @@
+import * as React from 'react';
+export function useGridLogger(apiRef, name) {
+  const logger = React.useRef(null);
+
+  if (logger.current) {
+    return logger.current;
+  }
+
+  const newLogger = apiRef.current.getLogger(name);
+  logger.current = newLogger;
+  return newLogger;
+}

package/hooks/utils/useGridNativeEventListener.d.ts

@@ -0,0 +1,3 @@
+import * as React from 'react';
+import { GridApiCommon } from '../../models';
+export declare const useGridNativeEventListener: <Api extends GridApiCommon, E extends Event>(apiRef: React.MutableRefObject<Api>, ref: React.MutableRefObject<HTMLDivElement | null> | (() => Element | undefined | null), eventName: string, handler?: ((event: E) => any) | undefined, options?: AddEventListenerOptions | undefined) => void;

package/hooks/utils/useGridNativeEventListener.js

@@ -0,0 +1,38 @@
+import * as React from 'react';
+import { GridEvents } from '../../models/events';
+import { isFunction } from '../../utils/utils';
+import { useGridLogger } from './useGridLogger';
+export const useGridNativeEventListener = (apiRef, ref, eventName, handler, options) => {
+  const logger = useGridLogger(apiRef, 'useNativeEventListener');
+  const [added, setAdded] = React.useState(false);
+  const handlerRef = React.useRef(handler);
+  const wrapHandler = React.useCallback(args => {
+    return handlerRef.current && handlerRef.current(args);
+  }, []);
+  React.useEffect(() => {
+    handlerRef.current = handler;
+  }, [handler]);
+  React.useEffect(() => {
+    let targetElement;
+
+    if (isFunction(ref)) {
+      targetElement = ref();
+    } else {
+      targetElement = ref && ref.current ? ref.current : null;
+    }
+
+    if (targetElement && wrapHandler && eventName && !added) {
+      logger.debug(`Binding native ${eventName} event`);
+      targetElement.addEventListener(eventName, wrapHandler, options);
+      const boundElem = targetElement;
+      setAdded(true);
+
+      const unsubscribe = () => {
+        logger.debug(`Clearing native ${eventName} event`);
+        boundElem.removeEventListener(eventName, wrapHandler, options);
+      };
+
+      apiRef.current.subscribeEvent(GridEvents.unmount, unsubscribe);
+    }
+  }, [ref, wrapHandler, eventName, added, logger, options, apiRef]);
+};

package/hooks/utils/useGridRootProps.d.ts

@@ -0,0 +1,2 @@
+import type { DataGridProcessedProps } from '../../models/props/DataGridProps';
+export declare const useGridRootProps: () => DataGridProcessedProps;

package/hooks/utils/useGridRootProps.js

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import { GridRootPropsContext } from '../../context/GridRootPropsContext';
+export const useGridRootProps = () => {
+  const contextValue = React.useContext(GridRootPropsContext);
+
+  if (!contextValue) {
+    throw new Error('MUI: useGridRootProps should only be used inside the DataGrid/DataGridPro component.');
+  }
+
+  return contextValue;
+};

package/hooks/utils/useGridScrollFn.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { GridScrollFn } from '../../models/params/gridScrollParams';
+import { GridApiCommunity } from '../../models/api/gridApiCommunity';
+export declare function useGridScrollFn(apiRef: React.MutableRefObject<GridApiCommunity>, renderingZoneElementRef: React.RefObject<HTMLDivElement>, columnHeadersElementRef: React.RefObject<HTMLDivElement>): [GridScrollFn];

package/hooks/utils/useGridScrollFn.js

@@ -0,0 +1,22 @@
+import * as React from 'react';
+import { useGridLogger } from './useGridLogger';
+export function useGridScrollFn(apiRef, renderingZoneElementRef, columnHeadersElementRef) {
+  const logger = useGridLogger(apiRef, 'useGridScrollFn');
+  const previousValue = React.useRef();
+  const scrollTo = React.useCallback(v => {
+    var _previousValue$curren;
+
+    if (v.left === ((_previousValue$curren = previousValue.current) == null ? void 0 : _previousValue$curren.left) && v.top === previousValue.current.top) {
+      return;
+    }
+
+    if (renderingZoneElementRef && renderingZoneElementRef.current) {
+      logger.debug(`Moving ${renderingZoneElementRef.current.className} to: ${v.left}-${v.top}`); // Force the creation of a layer, avoid paint when changing the transform value.
+
+      renderingZoneElementRef.current.style.transform = `translate3d(${-v.left}px, ${-v.top}px, 0px)`;
+      columnHeadersElementRef.current.style.transform = `translate3d(${-v.left}px, 0px, 0px)`;
+      previousValue.current = v;
+    }
+  }, [renderingZoneElementRef, logger, columnHeadersElementRef]);
+  return [scrollTo];
+}

package/hooks/utils/useGridSelector.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { GridApiCommon } from '../../models/api/gridApiCommon';
+import { OutputSelector } from '../../utils/createSelector';
+export declare const useGridSelector: <Api extends GridApiCommon, T>(apiRef: React.MutableRefObject<Api>, selector: OutputSelector<Api["state"], T> | ((state: Api["state"]) => T)) => T;

package/hooks/utils/useGridSelector.js

@@ -0,0 +1,20 @@
+let warnedOnceStateNotInitialized = false;
+
+function isOutputSelector(selector) {
+  return selector.cache;
+}
+
+export const useGridSelector = (apiRef, selector) => {
+  if (process.env.NODE_ENV !== 'production') {
+    if (!warnedOnceStateNotInitialized && !apiRef.current.state) {
+      warnedOnceStateNotInitialized = true;
+      console.warn(['MUI: `useGridSelector` has been called before the initialization of the state.', 'This hook can only be used inside the context of the grid.'].join('\n'));
+    }
+  }
+
+  if (isOutputSelector(selector)) {
+    return selector(apiRef);
+  }
+
+  return selector(apiRef.current.state);
+};

package/hooks/utils/useGridState.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { GridApiCommon } from '../../models/api/gridApiCommon';
+import { GridApiCommunity } from '../../models/api/gridApiCommunity';
+/**
+ * @deprecated Use `apiRef.current.state`, `apiRef.current.setState` and `apiRef.current.forceUpdate` instead.
+ */
+export declare const useGridState: <Api extends GridApiCommon = GridApiCommunity>(apiRef: React.MutableRefObject<Api>) => readonly [any, any, any];

package/hooks/utils/useGridState.js

@@ -0,0 +1,4 @@
+/**
+ * @deprecated Use `apiRef.current.state`, `apiRef.current.setState` and `apiRef.current.forceUpdate` instead.
+ */
+export const useGridState = apiRef => [apiRef.current.state, apiRef.current.setState, apiRef.current.forceUpdate];

package/hooks/utils/useGridStateInit.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import type { GridApiCommon } from '../../models';
+declare type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+export declare const useGridStateInit: <Api extends GridApiCommon>(apiRef: React.MutableRefObject<Api>, callback: (state: DeepPartial<Api["state"]>) => DeepPartial<Api["state"]>) => void;
+export {};

package/hooks/utils/useGridStateInit.js

@@ -0,0 +1,9 @@
+import * as React from 'react';
+export const useGridStateInit = (apiRef, callback) => {
+  const isInitialized = React.useRef(false);
+
+  if (!isInitialized.current) {
+    apiRef.current.state = callback(apiRef.current.state);
+    isInitialized.current = true;
+  }
+};

package/index.d.ts

@@ -0,0 +1,32 @@
+import * as React from 'react';
+import { GridApiCommunity } from './models/api/gridApiCommunity';
+import { GridInitialStateCommunity, GridStateCommunity } from './models/gridStateCommunity';
+export { useGridApiContext } from './hooks/utils/useGridApiContext';
+export { useGridApiRef } from './hooks/utils/useGridApiRef';
+export { useGridRootProps } from './hooks/utils/useGridRootProps';
+export * from './DataGrid';
+export * from './components';
+export * from './constants';
+export * from './hooks';
+export * from './locales';
+export * from './models';
+export * from './context';
+export * from './colDef';
+export * from './utils';
+export type { DataGridProps, GridExperimentalFeatures } from './models/props/DataGridProps';
+/**
+ * The full grid API.
+ */
+export declare type GridApi = GridApiCommunity;
+/**
+ * The state of `DataGrid`.
+ */
+export declare type GridState = GridStateCommunity;
+/**
+ * The initial state of `DataGrid`.
+ */
+export declare type GridInitialState = GridInitialStateCommunity;
+/**
+ * @deprecated Use `React.MutableRefObject<GridApi>` instead
+ */
+export declare type GridApiRef = React.MutableRefObject<GridApiCommunity>;

package/index.js

@@ -0,0 +1,17 @@
+/** @license MUI v5.6.0
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { useGridApiContext } from './hooks/utils/useGridApiContext';
+export { useGridApiRef } from './hooks/utils/useGridApiRef';
+export { useGridRootProps } from './hooks/utils/useGridRootProps';
+export * from './DataGrid';
+export * from './components';
+export * from './constants';
+export * from './hooks';
+export * from './locales';
+export * from './models';
+export * from './context';
+export * from './colDef';
+export * from './utils';

package/internals/index.d.ts

@@ -0,0 +1,53 @@
+export { GridVirtualScroller } from '../components/virtualization/GridVirtualScroller';
+export { GridVirtualScrollerContent } from '../components/virtualization/GridVirtualScrollerContent';
+export { GridVirtualScrollerRenderZone } from '../components/virtualization/GridVirtualScrollerRenderZone';
+export { GridColumnHeaders } from '../components/columnHeaders/GridColumnHeaders';
+export { GridColumnHeadersInner } from '../components/columnHeaders/GridColumnHeadersInner';
+export { useGridRegisterPreProcessor } from '../hooks/core/preProcessing';
+export type { GridPreProcessor } from '../hooks/core/preProcessing';
+export type { GridRowGroupingPreProcessing, GridRowGroupParams, GridRowGroupingResult, } from '../hooks/core/rowGroupsPreProcessing';
+export { useGridInitialization } from '../hooks/core/useGridInitialization';
+export { useGridClipboard } from '../hooks/features/clipboard/useGridClipboard';
+export { useGridColumnHeaders } from '../hooks/features/columnHeaders/useGridColumnHeaders';
+export { useGridColumnMenu } from '../hooks/features/columnMenu/useGridColumnMenu';
+export { useGridColumns, columnsStateInitializer } from '../hooks/features/columns/useGridColumns';
+export type { GridColumnRawLookup, GridColumnsRawState, } from '../hooks/features/columns/gridColumnsInterfaces';
+export { useGridDensity } from '../hooks/features/density/useGridDensity';
+export { useGridCsvExport } from '../hooks/features/export/useGridCsvExport';
+export { useGridPrintExport } from '../hooks/features/export/useGridPrintExport';
+export { useGridFilter, filterStateInitializer } from '../hooks/features/filter/useGridFilter';
+export { useGridRegisterFilteringMethod } from '../hooks/features/filter/useGridRegisterFilteringMethod';
+export type { GridFilteringMethod, GridAggregatedFilterItemApplier, } from '../hooks/features/filter/gridFilterState';
+export { useGridFocus } from '../hooks/features/focus/useGridFocus';
+export { useGridKeyboard } from '../hooks/features/keyboard/useGridKeyboard';
+export { useGridKeyboardNavigation } from '../hooks/features/keyboard/useGridKeyboardNavigation';
+export { useGridPagination } from '../hooks/features/pagination/useGridPagination';
+export { pageStateInitializer } from '../hooks/features/pagination/useGridPage';
+export { pageSizeStateInitializer } from '../hooks/features/pagination/useGridPageSize';
+export { useGridPreferencesPanel } from '../hooks/features/preferencesPanel/useGridPreferencesPanel';
+export { useGridEditing } from '../hooks/features/editRows/useGridEditing';
+export { useGridRows, rowsStateInitializer } from '../hooks/features/rows/useGridRows';
+export { useGridRowsMeta } from '../hooks/features/rows/useGridRowsMeta';
+export { useGridParamsApi } from '../hooks/features/rows/useGridParamsApi';
+export { useGridSelection } from '../hooks/features/selection/useGridSelection';
+export { useGridSelectionPreProcessors } from '../hooks/features/selection/useGridSelectionPreProcessors';
+export { useGridSorting, sortingStateInitializer } from '../hooks/features/sorting/useGridSorting';
+export { useGridRegisterSortingMethod } from '../hooks/features/sorting/useGridRegisterSortingMethod';
+export type { GridSortingMethod, GridSortingModelApplier, } from '../hooks/features/sorting/gridSortingState';
+export { useGridScroll } from '../hooks/features/scroll/useGridScroll';
+export { useGridEvents } from '../hooks/features/events/useGridEvents';
+export { useGridDimensions } from '../hooks/features/dimensions/useGridDimensions';
+export { useGridStatePersistence } from '../hooks/features/statePersistence/useGridStatePersistence';
+export type { GridRestoreStatePreProcessingContext } from '../hooks/features/statePersistence/gridStatePersistenceInterface';
+export { useGridVirtualScroller } from '../hooks/features/virtualization/useGridVirtualScroller';
+export { useCurrentPageRows } from '../hooks/utils/useCurrentPageRows';
+export { useGridInitializeState } from '../hooks/utils/useGridInitializeState';
+export type { GridStateInitializer } from '../hooks/utils/useGridInitializeState';
+export { useGridStateInit } from '../hooks/utils/useGridStateInit';
+export type { GridComparatorFn, GridSortCellParams } from '../models/gridSortModel';
+export type { GridSortModelParams } from '../models/params/gridSortModelParams';
+export type { GridExperimentalFeatures, DataGridPropsWithoutDefaultValue, DataGridPropsWithDefaultValues, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridPropsWithComplexDefaultValueBeforeProcessing, } from '../models/props/DataGridProps';
+export { createSelector } from '../utils/createSelector';
+export { findParentElementFromClassName } from '../utils/domUtils';
+export { isNavigationKey } from '../utils/keyboardUtils';
+export { clamp, isDeepEqual } from '../utils/utils';

package/internals/index.js

@@ -0,0 +1,43 @@
+export { GridVirtualScroller } from '../components/virtualization/GridVirtualScroller';
+export { GridVirtualScrollerContent } from '../components/virtualization/GridVirtualScrollerContent';
+export { GridVirtualScrollerRenderZone } from '../components/virtualization/GridVirtualScrollerRenderZone';
+export { GridColumnHeaders } from '../components/columnHeaders/GridColumnHeaders';
+export { GridColumnHeadersInner } from '../components/columnHeaders/GridColumnHeadersInner';
+export { useGridRegisterPreProcessor } from '../hooks/core/preProcessing';
+export { useGridInitialization } from '../hooks/core/useGridInitialization';
+export { useGridClipboard } from '../hooks/features/clipboard/useGridClipboard';
+export { useGridColumnHeaders } from '../hooks/features/columnHeaders/useGridColumnHeaders';
+export { useGridColumnMenu } from '../hooks/features/columnMenu/useGridColumnMenu';
+export { useGridColumns, columnsStateInitializer } from '../hooks/features/columns/useGridColumns';
+export { useGridDensity } from '../hooks/features/density/useGridDensity';
+export { useGridCsvExport } from '../hooks/features/export/useGridCsvExport';
+export { useGridPrintExport } from '../hooks/features/export/useGridPrintExport';
+export { useGridFilter, filterStateInitializer } from '../hooks/features/filter/useGridFilter';
+export { useGridRegisterFilteringMethod } from '../hooks/features/filter/useGridRegisterFilteringMethod';
+export { useGridFocus } from '../hooks/features/focus/useGridFocus';
+export { useGridKeyboard } from '../hooks/features/keyboard/useGridKeyboard';
+export { useGridKeyboardNavigation } from '../hooks/features/keyboard/useGridKeyboardNavigation';
+export { useGridPagination } from '../hooks/features/pagination/useGridPagination';
+export { pageStateInitializer } from '../hooks/features/pagination/useGridPage';
+export { pageSizeStateInitializer } from '../hooks/features/pagination/useGridPageSize';
+export { useGridPreferencesPanel } from '../hooks/features/preferencesPanel/useGridPreferencesPanel';
+export { useGridEditing } from '../hooks/features/editRows/useGridEditing';
+export { useGridRows, rowsStateInitializer } from '../hooks/features/rows/useGridRows';
+export { useGridRowsMeta } from '../hooks/features/rows/useGridRowsMeta';
+export { useGridParamsApi } from '../hooks/features/rows/useGridParamsApi';
+export { useGridSelection } from '../hooks/features/selection/useGridSelection';
+export { useGridSelectionPreProcessors } from '../hooks/features/selection/useGridSelectionPreProcessors';
+export { useGridSorting, sortingStateInitializer } from '../hooks/features/sorting/useGridSorting';
+export { useGridRegisterSortingMethod } from '../hooks/features/sorting/useGridRegisterSortingMethod';
+export { useGridScroll } from '../hooks/features/scroll/useGridScroll';
+export { useGridEvents } from '../hooks/features/events/useGridEvents';
+export { useGridDimensions } from '../hooks/features/dimensions/useGridDimensions';
+export { useGridStatePersistence } from '../hooks/features/statePersistence/useGridStatePersistence';
+export { useGridVirtualScroller } from '../hooks/features/virtualization/useGridVirtualScroller';
+export { useCurrentPageRows } from '../hooks/utils/useCurrentPageRows';
+export { useGridInitializeState } from '../hooks/utils/useGridInitializeState';
+export { useGridStateInit } from '../hooks/utils/useGridStateInit';
+export { createSelector } from '../utils/createSelector';
+export { findParentElementFromClassName } from '../utils/domUtils';
+export { isNavigationKey } from '../utils/keyboardUtils';
+export { clamp, isDeepEqual } from '../utils/utils';

package/internals/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/internals/index.js",
+  "types": "./index.d.ts"
+}