@mui/x-data-grid-premium 8.9.0 → 8.9.2

package/hooks/features/sidebar/gridSidebarState.js

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

package/hooks/features/sidebar/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./gridSidebarInterfaces.js";
+export * from "./gridSidebarSelector.js";
+export * from "./gridSidebarState.js";

package/hooks/features/sidebar/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _gridSidebarInterfaces = require("./gridSidebarInterfaces");
+Object.keys(_gridSidebarInterfaces).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _gridSidebarInterfaces[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _gridSidebarInterfaces[key];
+    }
+  });
+});
+var _gridSidebarSelector = require("./gridSidebarSelector");
+Object.keys(_gridSidebarSelector).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _gridSidebarSelector[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _gridSidebarSelector[key];
+    }
+  });
+});
+var _gridSidebarState = require("./gridSidebarState");
+Object.keys(_gridSidebarState).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _gridSidebarState[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _gridSidebarState[key];
+    }
+  });
+});

package/hooks/features/sidebar/useGridSidebar.d.ts

@@ -0,0 +1,6 @@
+import { RefObject } from '@mui/x-internals/types';
+import { GridStateInitializer } from '@mui/x-data-grid-pro/internals';
+import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
+import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
+export declare const sidebarStateInitializer: GridStateInitializer<Pick<DataGridPremiumProcessedProps, 'initialState'>>;
+export declare const useGridSidebar: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "initialState" | "onSidebarClose" | "onSidebarOpen">) => void;

package/hooks/features/sidebar/useGridSidebar.js

@@ -0,0 +1,82 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useGridSidebar = exports.sidebarStateInitializer = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var React = _interopRequireWildcard(require("react"));
+var _internals = require("@mui/x-data-grid-pro/internals");
+var _gridSidebarSelector = require("./gridSidebarSelector");
+const sidebarStateInitializer = (state, props) => (0, _extends2.default)({}, state, {
+  sidebar: props.initialState?.sidebar ?? {
+    open: false
+  }
+});
+exports.sidebarStateInitializer = sidebarStateInitializer;
+const useGridSidebar = (apiRef, props) => {
+  const hideSidebar = React.useCallback(() => {
+    apiRef.current.setState(state => {
+      if (!state.sidebar.open || !state.sidebar.value) {
+        return state;
+      }
+      apiRef.current.publishEvent('sidebarClose', {
+        value: state.sidebar.value
+      });
+      return (0, _extends2.default)({}, state, {
+        sidebar: {
+          open: false
+        }
+      });
+    });
+  }, [apiRef]);
+  const showSidebar = React.useCallback((newValue, sidebarId, labelId) => {
+    apiRef.current.setState(state => (0, _extends2.default)({}, state, {
+      sidebar: (0, _extends2.default)({}, state.sidebar, {
+        open: true,
+        value: newValue,
+        sidebarId,
+        labelId
+      })
+    }));
+    apiRef.current.publishEvent('sidebarOpen', {
+      value: newValue
+    });
+  }, [apiRef]);
+  (0, _internals.useGridApiMethod)(apiRef, {
+    showSidebar,
+    hideSidebar
+  }, 'public');
+  const stateExportPreProcessing = React.useCallback((prevState, context) => {
+    const sidebarToExport = (0, _gridSidebarSelector.gridSidebarStateSelector)(apiRef);
+    const shouldExportSidebar =
+    // Always export if the `exportOnlyDirtyModels` property is not activated
+    !context.exportOnlyDirtyModels ||
+    // Always export if the sidebar was initialized
+    props.initialState?.sidebar != null ||
+    // Always export if the sidebar is opened
+    sidebarToExport.open;
+    if (!shouldExportSidebar) {
+      return prevState;
+    }
+    return (0, _extends2.default)({}, prevState, {
+      sidebar: sidebarToExport
+    });
+  }, [apiRef, props.initialState?.sidebar]);
+  const stateRestorePreProcessing = React.useCallback((params, context) => {
+    const sidebar = context.stateToRestore.sidebar;
+    if (sidebar != null) {
+      apiRef.current.setState(state => (0, _extends2.default)({}, state, {
+        sidebar
+      }));
+    }
+    return params;
+  }, [apiRef]);
+  (0, _internals.useGridRegisterPipeProcessor)(apiRef, 'exportState', stateExportPreProcessing);
+  (0, _internals.useGridRegisterPipeProcessor)(apiRef, 'restoreState', stateRestorePreProcessing);
+  (0, _internals.useGridEventPriority)(apiRef, 'sidebarClose', props.onSidebarClose);
+  (0, _internals.useGridEventPriority)(apiRef, 'sidebarOpen', props.onSidebarOpen);
+};
+exports.useGridSidebar = useGridSidebar;

package/hooks/utils/useGridAriaAttributes.d.ts

@@ -1,2 +1,2 @@
 import * as React from 'react';
-export declare const useGridAriaAttributes: () => React.HTMLAttributes<HTMLElement>;
+export declare const useGridAriaAttributesPremium: () => React.HTMLAttributes<HTMLElement>;

package/hooks/utils/useGridAriaAttributes.js

@@ -4,13 +4,13 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useGridAriaAttributes = void 0;
+exports.useGridAriaAttributesPremium = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _internals = require("@mui/x-data-grid-pro/internals");
 var _gridRowGroupingSelector = require("../features/rowGrouping/gridRowGroupingSelector");
 var _useGridPrivateApiContext = require("./useGridPrivateApiContext");
-const useGridAriaAttributes = () => {
-  const ariaAttributesPro = (0, _internals.useGridAriaAttributes)();
+const useGridAriaAttributesPremium = () => {
+  const ariaAttributesPro = (0, _internals.useGridAriaAttributesPro)();
   const apiRef = (0, _useGridPrivateApiContext.useGridPrivateApiContext)();
   const gridRowGroupingModel = (0, _internals.useGridSelector)(apiRef, _gridRowGroupingSelector.gridRowGroupingSanitizedModelSelector);
   const ariaAttributesPremium = gridRowGroupingModel.length > 0 ? {
@@ -18,4 +18,4 @@ const useGridAriaAttributes = () => {
   } : {};
   return (0, _extends2.default)({}, ariaAttributesPro, ariaAttributesPremium);
 };
-exports.useGridAriaAttributes = useGridAriaAttributes;
+exports.useGridAriaAttributesPremium = useGridAriaAttributesPremium;

package/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-data-grid-premium v8.9.0
+ * @mui/x-data-grid-premium v8.9.2
  *
  * @license SEE LICENSE IN LICENSE
  * This source code is licensed under the SEE LICENSE IN LICENSE license found in the

package/models/dataGridPremiumProps.d.ts

@@ -205,11 +205,13 @@ export interface DataGridPremiumPropsWithoutDefaultValue<R extends GridValidRowM
   /**
    * If `true`, the pivot side panel is visible.
    * @default false
+   * @deprecated Use `initialState.sidebar.open` instead.
    */
   pivotPanelOpen?: boolean;
   /**
    * Callback fired when the pivot side panel open state changes.
    * @param {boolean} pivotPanelOpen Whether the pivot side panel is visible.
+   * @deprecated Use the `sidebarOpen` and `sidebarClose` events or corresponding event handlers `onSidebarOpen()` and `onSidebarClose()` instead.
    */
   onPivotPanelOpenChange?: (pivotPanelOpen: boolean) => void;
   /**
@@ -254,4 +256,18 @@ export interface DataGridPremiumPropsWithoutDefaultValue<R extends GridValidRowM
    * @returns {Promise<PromptResponse>} The prompt response.
    */
   onPrompt?: (prompt: string, promptContext: string, conversationId?: string) => Promise<PromptResponse>;
+  /**
+   * Callback fired when the sidebar is closed.
+   * @param {GridSidebarParams} params With all properties from [[GridSidebarParams]].
+   * @param {MuiEvent<{}>} event The event object.
+   * @param {GridCallbackDetails} details Additional details for this callback.
+   */
+  onSidebarClose?: GridEventListener<'sidebarClose'>;
+  /**
+   * Callback fired when the sidebar is opened.
+   * @param {GridSidebarParams} params With all properties from [[GridSidebarParams]].
+   * @param {MuiEvent<{}>} event The event object.
+   * @param {GridCallbackDetails} details Additional details for this callback.
+   */
+  onSidebarOpen?: GridEventListener<'sidebarOpen'>;
 }

package/models/gridApiPremium.d.ts

@@ -8,9 +8,10 @@ import type { GridDataSourcePremiumPrivateApi, GridDataSourceApiPremium } from "
 import type { GridAggregationPrivateApi } from "../hooks/features/aggregation/gridAggregationInterfaces.js";
 import type { GridPivotingApi, GridPivotingPrivateApi } from "../hooks/features/pivoting/gridPivotingInterfaces.js";
 import { GridAiAssistantApi } from "../hooks/features/aiAssistant/gridAiAssistantInterfaces.js";
+import { GridSidebarApi } from "../hooks/features/sidebar/gridSidebarInterfaces.js";
 /**
  * The api of Data Grid Premium.
  * TODO: Do not redefine manually the pro features
  */
-export interface GridApiPremium extends GridApiCommon<GridStatePremium, GridInitialStatePremium>, GridRowProApi, GridColumnPinningApi, GridDetailPanelApi, GridRowGroupingApi, GridExcelExportApi, GridAggregationApi, GridRowPinningApi, GridDataSourceApiPremium, GridCellSelectionApi, GridPivotingApi, GridAiAssistantApi, GridRowMultiSelectionApi, GridColumnReorderApi {}
+export interface GridApiPremium extends GridApiCommon<GridStatePremium, GridInitialStatePremium>, GridRowProApi, GridColumnPinningApi, GridDetailPanelApi, GridRowGroupingApi, GridExcelExportApi, GridAggregationApi, GridRowPinningApi, GridDataSourceApiPremium, GridCellSelectionApi, GridPivotingApi, GridAiAssistantApi, GridSidebarApi, GridRowMultiSelectionApi, GridColumnReorderApi {}
 export interface GridPrivateApiPremium extends GridApiPremium, GridPrivateOnlyApiCommon<GridApiPremium, GridPrivateApiPremium, DataGridPremiumProcessedProps>, GridDataSourcePremiumPrivateApi, GridAggregationPrivateApi, GridDetailPanelPrivateApi, GridPivotingPrivateApi {}

package/models/gridStatePremium.d.ts

@@ -2,6 +2,7 @@ import { GridInitialState as GridInitialStatePro, GridState as GridStatePro } fr
 import type { GridRowGroupingState, GridRowGroupingInitialState, GridAggregationState, GridAggregationInitialState, GridCellSelectionModel } from "../hooks/index.js";
 import type { GridPivotingInitialState, GridPivotingState } from "../hooks/features/pivoting/gridPivotingInterfaces.js";
 import { GridAiAssistantInitialState, GridAiAssistantState } from "../hooks/features/aiAssistant/gridAiAssistantInterfaces.js";
+import { GridSidebarInitialState, GridSidebarState } from "../hooks/features/sidebar/gridSidebarState.js";
 /**
  * The state of Data Grid Premium.
  */
@@ -11,6 +12,7 @@ export interface GridStatePremium extends GridStatePro {
   cellSelection: GridCellSelectionModel;
   pivoting: GridPivotingState;
   aiAssistant: GridAiAssistantState;
+  sidebar: GridSidebarState;
 }
 /**
  * The initial state of Data Grid Premium.
@@ -21,4 +23,5 @@ export interface GridInitialStatePremium extends GridInitialStatePro {
   cellSelection?: GridCellSelectionModel;
   pivoting?: GridPivotingInitialState;
   aiAssistant?: GridAiAssistantInitialState;
+  sidebar?: GridSidebarInitialState;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-data-grid-premium",
-  "version": "8.9.0",
+  "version": "8.9.2",
   "author": "MUI Team",
   "description": "The Premium plan edition of the MUI X Data Grid Components.",
   "main": "./index.js",
@@ -13,8 +13,7 @@
     "**/*.css"
   ],
   "publishConfig": {
-    "access": "public",
-    "directory": "build"
+    "access": "public"
   },
   "keywords": [
     "react",
@@ -35,16 +34,16 @@
     "directory": "packages/x-data-grid-premium"
   },
   "dependencies": {
-    "@babel/runtime": "^7.27.6",
+    "@babel/runtime": "^7.28.2",
     "@mui/utils": "^7.2.0",
     "@types/format-util": "^1.0.4",
     "clsx": "^2.1.1",
     "exceljs": "^4.4.0",
     "prop-types": "^15.8.1",
-    "@mui/x-data-grid": "8.8.0",
-    "@mui/x-data-grid-pro": "8.9.0",
-    "@mui/x-license": "8.9.0",
-    "@mui/x-internals": "8.8.0"
+    "@mui/x-internals": "8.9.2",
+    "@mui/x-data-grid-pro": "8.9.2",
+    "@mui/x-license": "8.9.2",
+    "@mui/x-data-grid": "8.9.2"
   },
   "peerDependencies": {
     "@emotion/react": "^11.9.0",

package/typeOverloads/modules.d.ts

@@ -1,11 +1,12 @@
 import { GridExportDisplayOptions, GridValidRowModel } from '@mui/x-data-grid-pro';
-import type { GridControlledStateEventLookupPro, GridApiCachesPro, GridEventLookupPro } from '@mui/x-data-grid-pro/typeOverloads';
+import type { GridPipeProcessingLookupPro, GridControlledStateEventLookupPro, GridApiCachesPro, GridEventLookupPro } from '@mui/x-data-grid-pro/typeOverloads';
 import type { GridGroupingValueGetter, GridPastedValueParser } from "../models/index.js";
 import type { GridRowGroupingModel, GridAggregationModel, GridAggregationCellMeta, GridAggregationHeaderMeta, GridCellSelectionModel, Conversation } from "../hooks/index.js";
 import { GridRowGroupingInternalCache } from "../hooks/features/rowGrouping/gridRowGroupingInterfaces.js";
 import { GridAggregationInternalCache } from "../hooks/features/aggregation/gridAggregationInterfaces.js";
 import type { GridExcelExportOptions } from "../hooks/features/export/gridExcelExportInterface.js";
 import type { GridPivotingInternalCache, GridPivotModel } from "../hooks/features/pivoting/gridPivotingInterfaces.js";
+import { GridSidebarValue } from "../hooks/features/sidebar/gridSidebarInterfaces.js";
 export interface GridControlledStateEventLookupPremium {
   /**
    * Fired when the aggregation model changes.
@@ -40,6 +41,9 @@ export interface GridControlledStateEventLookupPremium {
   pivotModeChange: {
     params: boolean;
   };
+  /**
+   * @deprecated Use the `sidebarOpen` and `sidebarClose` events instead.
+   */
   pivotPanelOpenChange: {
     params: boolean;
   };
@@ -69,6 +73,22 @@ interface GridEventLookupPremium extends GridEventLookupPro {
    * Fired when the clipboard paste operation ends.
    */
   clipboardPasteEnd: {};
+  /**
+   * Fired when the sidebar is opened.
+   */
+  sidebarOpen: {
+    params: {
+      value: GridSidebarValue;
+    };
+  };
+  /**
+   * Fired when the sidebar is closed.
+   */
+  sidebarClose: {
+    params: {
+      value: GridSidebarValue;
+    };
+  };
 }
 export interface GridColDefPremium<R extends GridValidRowModel = any, V = any, F = V> {
   /**
@@ -109,8 +129,15 @@ export interface GridApiCachesPremium extends GridApiCachesPro {
   rowGrouping: GridRowGroupingInternalCache;
   aggregation: GridAggregationInternalCache;
 }
+export interface GridPipeProcessingLookupPremium {
+  sidebar: {
+    value: React.ReactNode;
+    context: GridSidebarValue;
+  };
+}
 declare module '@mui/x-data-grid-pro' {
   interface GridEventLookup extends GridEventLookupPremium {}
+  interface GridPipeProcessingLookup extends GridPipeProcessingLookupPro, GridPipeProcessingLookupPremium {}
   interface GridControlledStateEventLookup extends GridControlledStateEventLookupPro, GridControlledStateEventLookupPremium {}
   interface GridRenderCellParams<R, V, F> extends GridRenderCellParamsPremium<R, V, F> {}
   interface GridColumnHeaderParams<R, V, F> extends GridColumnHeaderParamsPremium<R, V, F> {}