@mui/x-data-grid-premium 8.0.0-alpha.0 → 8.0.0-alpha.2

package/DataGridPremium/DataGridPremium.js

@@ -459,14 +459,6 @@ process.env.NODE_ENV !== "production" ? DataGridPremiumRaw.propTypes = {
     clipboardExport: _propTypes.default.bool,
     csvExport: _propTypes.default.bool
   }), _propTypes.default.bool]),
-  /**
-   * If `select`, a group header checkbox in indeterminate state (like "Select All" checkbox)
-   * will select all the rows under it.
-   * If `deselect`, it will deselect all the rows under it.
-   * Works only if `checkboxSelection` is enabled.
-   * @default "deselect"
-   */
-  indeterminateCheckboxAction: _propTypes.default.oneOf(['deselect', 'select']),
   /**
    * The initial state of the DataGridPremium.
    * The data in it is set in the state on initialization but isn't controlled.
@@ -971,7 +963,7 @@ process.env.NODE_ENV !== "production" ? DataGridPremiumRaw.propTypes = {
    * - Deselecting a descendant of a selected parent deselects the parent automatically.
    *
    * Works with tree data and row grouping on the client-side only.
-   * @default { parents: false, descendants: false }
+   * @default { parents: true, descendants: true }
    */
   rowSelectionPropagation: _propTypes.default.shape({
     descendants: _propTypes.default.bool,
@@ -1088,7 +1080,15 @@ process.env.NODE_ENV !== "production" ? DataGridPremiumRaw.propTypes = {
    * If `true`, the Data Grid will auto span the cells over the rows having the same value.
    * @default false
    */
-  unstable_rowSpanning: _propTypes.default.bool
+  unstable_rowSpanning: _propTypes.default.bool,
+  /**
+   * If `true`, the Data Grid enables column virtualization when `getRowHeight` is set to `() => 'auto'`.
+   * By default, column virtualization is disabled when dynamic row height is enabled to measure the row height correctly.
+   * For datasets with a large number of columns, this can cause performance issues.
+   * The downside of enabling this prop is that the row height will be estimated based the cells that are currently rendered, which can cause row height change when scrolling horizontally.
+   * @default false
+   */
+  virtualizeColumnsWithAutoRowHeight: _propTypes.default.bool
 } : void 0;
 /**
  * Demos:

package/README.md

@@ -16,8 +16,8 @@ This component has the following peer dependencies that you need to install as w
 ```json
 "peerDependencies": {
   "@mui/material": "^5.15.14 || ^6.0.0",
-  "react": "^17.0.0 || ^18.0.0",
-  "react-dom": "^17.0.0 || ^18.0.0"
+  "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
+  "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
 },
 ```
 

package/components/index.d.ts

@@ -1,4 +1,5 @@
 export * from './GridExcelExportMenuItem';
 export * from '../material/icons';
 export * from './GridColumnMenuAggregationItem';
+export * from './promptControl';
 export { GridColumnMenuGroupingItem } from './GridPremiumColumnMenu';

package/components/index.js

@@ -48,4 +48,16 @@ Object.keys(_GridColumnMenuAggregationItem).forEach(function (key) {
     }
   });
 });
+var _promptControl = require("./promptControl");
+Object.keys(_promptControl).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _promptControl[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _promptControl[key];
+    }
+  });
+});
 var _GridPremiumColumnMenu = require("./GridPremiumColumnMenu");

package/components/promptControl/GridToolbarPromptControl.d.ts

@@ -0,0 +1,26 @@
+import * as React from 'react';
+import { PromptResponse } from '../../hooks/features/promptControl/types';
+type GridToolbarPromptControlProps = {
+    /**
+     * Called when the new prompt is ready to be processed.
+     * Provides the prompt and the data context and expects the grid state updates to be returned.
+     * @param {string} context The context of the prompt
+     * @param {string} query The query to process
+     * @returns {Promise<PromptResponse>} The grid state updates
+     */
+    onPrompt: (context: string, query: string) => Promise<PromptResponse>;
+    /**
+     * Allow taking couple of random cell values from each column to improve the prompt context.
+     * If allowed, samples are taken from different rows.
+     * If not allowed, the column examples are used.
+     * @default false
+     */
+    allowDataSampling?: boolean;
+    /**
+     * The BCP 47 language tag to use for the speech recognition.
+     * @default HTML lang attribute value or the user agent's language setting
+     */
+    lang?: string;
+};
+declare function GridToolbarPromptControl(props: GridToolbarPromptControlProps): React.JSX.Element;
+export { GridToolbarPromptControl };

package/components/promptControl/GridToolbarPromptControl.js

@@ -0,0 +1,209 @@
+"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.GridToolbarPromptControl = GridToolbarPromptControl;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var React = _interopRequireWildcard(require("react"));
+var _styles = require("@mui/material/styles");
+var _composeClasses = _interopRequireDefault(require("@mui/utils/composeClasses"));
+var _useEventCallback = _interopRequireDefault(require("@mui/utils/useEventCallback"));
+var _xDataGrid = require("@mui/x-data-grid");
+var _internals = require("@mui/x-data-grid/internals");
+var _useGridApiContext = require("../../hooks/utils/useGridApiContext");
+var _useGridRootProps = require("../../hooks/utils/useGridRootProps");
+var _RecordButton = require("./RecordButton");
+var _jsxRuntime = require("react/jsx-runtime");
+const supportsSpeechRecognition = !!_RecordButton.BrowserSpeechRecognition;
+const useUtilityClasses = (ownerState, recording) => {
+  const {
+    classes
+  } = ownerState;
+  const slots = {
+    root: ['toolbarPromptControl', recording && 'toolbarPromptControl--recording'],
+    recordingIndicator: ['toolbarPromptControlRecordingIndicator'],
+    recordButton: ['toolbarPromptControlRecordButton'],
+    sendButton: ['toolbarPromptControlSendButton']
+  };
+  return (0, _composeClasses.default)(slots, _xDataGrid.getDataGridUtilityClass, classes);
+};
+const GridToolbarPromptControlRoot = (0, _styles.styled)('div', {
+  name: 'MuiDataGrid',
+  slot: 'ToolbarPromptControl',
+  overridesResolver: (_, styles) => styles.toolbarPromptControl
+})({
+  flex: 1,
+  display: 'flex',
+  flexDirection: 'row'
+});
+function sampleData(apiRef) {
+  const columns = (0, _xDataGrid.gridColumnDefinitionsSelector)(apiRef);
+  const rows = Object.values((0, _xDataGrid.gridRowsLookupSelector)(apiRef));
+  const columnExamples = {};
+  columns.forEach(column => {
+    columnExamples[column.field] = Array.from({
+      length: Math.min(5, rows.length)
+    }).map(() => {
+      const row = rows[Math.floor(Math.random() * rows.length)];
+      if (column.valueGetter) {
+        return column.valueGetter(row[column.field], row, column, apiRef);
+      }
+      return row[column.field];
+    });
+  });
+  return columnExamples;
+}
+function generateContext(apiRef, examples) {
+  const columns = (0, _xDataGrid.gridColumnDefinitionsSelector)(apiRef);
+  const columnsContext = columns.map(column => ({
+    field: column.field,
+    description: column.description ?? null,
+    examples: examples?.[column.field] ?? column.unstable_examples ?? [],
+    type: column.type ?? 'string',
+    allowedOperators: column.filterOperators?.map(operator => operator.value) ?? []
+  }));
+  return `The columns are described by the following JSON:\n${JSON.stringify(columnsContext)}`;
+}
+function GridToolbarPromptControl(props) {
+  const apiRef = (0, _useGridApiContext.useGridApiContext)();
+  const rootProps = (0, _useGridRootProps.useGridRootProps)();
+  const {
+    onPrompt,
+    lang,
+    allowDataSampling = false
+  } = props;
+  const [isLoading, setLoading] = React.useState(false);
+  const [error, setError] = React.useState(null);
+  const [isRecording, setRecording] = React.useState(false);
+  const [query, setQuery] = React.useState('');
+  const classes = useUtilityClasses(rootProps, isRecording);
+  const examplesFromData = React.useMemo(() => allowDataSampling ? sampleData(apiRef) : undefined, [apiRef, allowDataSampling]);
+  const processPrompt = React.useCallback(() => {
+    const context = generateContext(apiRef, examplesFromData);
+    const columnsByField = (0, _xDataGrid.gridColumnLookupSelector)(apiRef);
+    setLoading(true);
+    setError(null);
+    apiRef.current.setLoading(true);
+    onPrompt(context, query).then(result => {
+      const interestColumns = [];
+      apiRef.current.setFilterModel({
+        items: result.filters.map((filter, index) => {
+          const item = {
+            id: index,
+            field: filter.column,
+            operator: filter.operator,
+            value: filter.value
+          };
+          const column = columnsByField[filter.column];
+          if (column.type === 'singleSelect') {
+            const options = (0, _internals.getValueOptions)(column) ?? [];
+            const found = options.find(option => typeof option === 'object' && option.label === filter.value);
+            if (found) {
+              item.value = found.value;
+            }
+          }
+          return item;
+        }),
+        logicOperator: result.filterOperator ?? _xDataGrid.GridLogicOperator.And,
+        quickFilterValues: []
+      });
+      apiRef.current.setRowGroupingModel(result.grouping.map(g => g.column));
+      apiRef.current.setAggregationModel(result.aggregation);
+      apiRef.current.setSortModel(result.sorting.map(s => ({
+        field: s.column,
+        sort: s.direction
+      })));
+      const rows = (0, _internals.getVisibleRows)(apiRef, rootProps);
+      const selectedRowIds = result.select === -1 ? [] : rows.rows.slice(0, result.select).map(r => {
+        return apiRef.current.getRowId(r);
+      });
+      apiRef.current.setRowSelectionModel(selectedRowIds);
+      const columns = apiRef.current.getAllColumns();
+      const targetIndex = Number(columns.find(c => c.field === _xDataGrid.GRID_CHECKBOX_SELECTION_FIELD) !== undefined) + Number(result.grouping.length);
+      interestColumns.push(...Object.keys(result.aggregation));
+      interestColumns.push(...result.filters.map(f => f.column));
+      interestColumns.reverse().forEach(c => apiRef.current.setColumnIndex(c, targetIndex));
+    }).catch(_ => {
+      setError(apiRef.current.getLocaleText('toolbarPromptControlErrorMessage'));
+    }).finally(() => {
+      setLoading(false);
+      apiRef.current.setState(state => (0, _extends2.default)({}, state, {
+        rows: (0, _extends2.default)({}, state.rows, {
+          loading: false
+        })
+      }));
+    });
+  }, [apiRef, rootProps, onPrompt, examplesFromData, query]);
+  const handleChange = (0, _useEventCallback.default)(event => {
+    setQuery(event.target.value);
+  });
+  const handleKeyDown = (0, _useEventCallback.default)(event => {
+    if (event.code === 'Enter') {
+      processPrompt();
+    }
+  });
+  const handleDone = (0, _useEventCallback.default)(value => {
+    setQuery(value);
+    if (value) {
+      processPrompt();
+    }
+  });
+  const placeholder = supportsSpeechRecognition ? apiRef.current.getLocaleText('toolbarPromptControlWithRecordingPlaceholder') : apiRef.current.getLocaleText('toolbarPromptControlPlaceholder');
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(GridToolbarPromptControlRoot, {
+    ownerState: rootProps,
+    className: classes.root,
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseTextField, {
+      variant: "outlined",
+      placeholder: isRecording ? apiRef.current.getLocaleText('toolbarPromptControlRecordingPlaceholder') : placeholder,
+      "aria-label": apiRef.current.getLocaleText('toolbarPromptControlLabel'),
+      disabled: isLoading,
+      value: query,
+      style: {
+        flex: 1
+      },
+      onChange: handleChange,
+      size: "small",
+      onKeyDown: handleKeyDown,
+      error: !!error,
+      helperText: error,
+      InputProps: {
+        startAdornment: supportsSpeechRecognition && /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseInputAdornment, {
+          position: "start",
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_RecordButton.RecordButton, {
+            className: classes.recordButton,
+            lang: lang,
+            recording: isRecording,
+            setRecording: setRecording,
+            disabled: isLoading,
+            onUpdate: setQuery,
+            onDone: handleDone,
+            onError: setError
+          })
+        }),
+        endAdornment: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseInputAdornment, {
+          position: "end",
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseTooltip, {
+            title: apiRef.current.getLocaleText('toolbarPromptControlSendActionLabel'),
+            children: /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+              children: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseIconButton, {
+                className: classes.sendButton,
+                disabled: isLoading || isRecording || query === '',
+                color: "primary",
+                onClick: processPrompt,
+                size: "small",
+                "aria-label": apiRef.current.getLocaleText('toolbarPromptControlSendActionAriaLabel'),
+                edge: "end",
+                children: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.toolbarPromptSendIcon, {
+                  fontSize: "small"
+                })
+              })
+            })
+          })
+        })
+      }
+    })
+  });
+}

package/components/promptControl/RecordButton.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+export declare const BrowserSpeechRecognition: any;
+type SpeechRecognitionOptions = {
+    onUpdate: (value: string) => void;
+    onDone: (value: string) => void;
+    onError: (error: string) => void;
+};
+interface RecordButtonProps extends SpeechRecognitionOptions {
+    disabled: boolean;
+    lang?: string;
+    recording: boolean;
+    setRecording: (value: boolean) => void;
+    className: string;
+}
+declare function RecordButton(props: RecordButtonProps): React.JSX.Element;
+export { RecordButton };

package/components/promptControl/RecordButton.js

@@ -0,0 +1,119 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BrowserSpeechRecognition = void 0;
+exports.RecordButton = RecordButton;
+var React = _interopRequireWildcard(require("react"));
+var _useTimeout = require("@mui/utils/useTimeout");
+var _useLazyRef = _interopRequireDefault(require("@mui/utils/useLazyRef"));
+var _useGridApiContext = require("../../hooks/utils/useGridApiContext");
+var _useGridRootProps = require("../../hooks/utils/useGridRootProps");
+var _jsxRuntime = require("react/jsx-runtime");
+const BrowserSpeechRecognition = exports.BrowserSpeechRecognition = globalThis.SpeechRecognition || globalThis.webkitSpeechRecognition;
+function RecordButton(props) {
+  const apiRef = (0, _useGridApiContext.useGridApiContext)();
+  const rootProps = (0, _useGridRootProps.useGridRootProps)();
+  const {
+    lang,
+    recording,
+    setRecording,
+    disabled,
+    className,
+    onDone,
+    onUpdate,
+    onError
+  } = props;
+  const buttonRef = React.useRef(null);
+  const recognition = (0, _useLazyRef.default)(() => {
+    if (!BrowserSpeechRecognition) {
+      return {
+        start: () => {},
+        abort: () => {}
+      };
+    }
+    const timeout = new _useTimeout.Timeout();
+    const instance = new BrowserSpeechRecognition();
+    instance.continuous = true;
+    instance.interimResults = true;
+    instance.lang = lang;
+    let finalResult = '';
+    let interimResult = '';
+    function start(options) {
+      if (recording) {
+        return;
+      }
+      setRecording(true);
+      instance.onresult = event => {
+        finalResult = '';
+        interimResult = '';
+        if (typeof event.results === 'undefined') {
+          instance.stop();
+          return;
+        }
+        for (let i = event.resultIndex; i < event.results.length; i += 1) {
+          if (event.results[i].isFinal) {
+            finalResult += event.results[i][0].transcript;
+          } else {
+            interimResult += event.results[i][0].transcript;
+          }
+        }
+        if (finalResult === '') {
+          options.onUpdate(interimResult);
+        }
+        timeout.start(1000, () => instance.stop());
+      };
+      instance.onsoundend = () => {
+        instance.stop();
+      };
+      instance.onend = () => {
+        options.onDone(finalResult);
+        setRecording(false);
+      };
+      instance.onerror = error => {
+        options.onError(error.message);
+        instance.stop();
+        setRecording(false);
+      };
+      instance.start();
+    }
+    function abort() {
+      instance.abort();
+    }
+    return {
+      start,
+      abort
+    };
+  }).current;
+  const handleClick = () => {
+    if (!recording) {
+      recognition.start({
+        onDone,
+        onUpdate,
+        onError
+      });
+      return;
+    }
+    recognition.abort();
+  };
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseTooltip, {
+    title: recording ? apiRef.current.getLocaleText('toolbarPromptControlRecordButtonActiveLabel') : apiRef.current.getLocaleText('toolbarPromptControlRecordButtonDefaultLabel'),
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.baseIconButton, {
+        color: recording ? 'primary' : 'default',
+        className: className,
+        disabled: disabled,
+        onClick: handleClick,
+        ref: buttonRef,
+        size: "small",
+        edge: "start",
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(rootProps.slots.toolbarPromptRecordIcon, {
+          fontSize: "small"
+        })
+      })
+    })
+  });
+}

package/components/promptControl/index.d.ts

@@ -0,0 +1 @@
+export { GridToolbarPromptControl as Unstable_GridToolbarPromptControl } from './GridToolbarPromptControl';

package/components/promptControl/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Unstable_GridToolbarPromptControl", {
+  enumerable: true,
+  get: function () {
+    return _GridToolbarPromptControl.GridToolbarPromptControl;
+  }
+});
+var _GridToolbarPromptControl = require("./GridToolbarPromptControl");

package/esm/DataGridPremium/DataGridPremium.js

@@ -452,14 +452,6 @@ process.env.NODE_ENV !== "production" ? DataGridPremiumRaw.propTypes = {
     clipboardExport: PropTypes.bool,
     csvExport: PropTypes.bool
   }), PropTypes.bool]),
-  /**
-   * If `select`, a group header checkbox in indeterminate state (like "Select All" checkbox)
-   * will select all the rows under it.
-   * If `deselect`, it will deselect all the rows under it.
-   * Works only if `checkboxSelection` is enabled.
-   * @default "deselect"
-   */
-  indeterminateCheckboxAction: PropTypes.oneOf(['deselect', 'select']),
   /**
    * The initial state of the DataGridPremium.
    * The data in it is set in the state on initialization but isn't controlled.
@@ -964,7 +956,7 @@ process.env.NODE_ENV !== "production" ? DataGridPremiumRaw.propTypes = {
    * - Deselecting a descendant of a selected parent deselects the parent automatically.
    *
    * Works with tree data and row grouping on the client-side only.
-   * @default { parents: false, descendants: false }
+   * @default { parents: true, descendants: true }
    */
   rowSelectionPropagation: PropTypes.shape({
     descendants: PropTypes.bool,
@@ -1081,7 +1073,15 @@ process.env.NODE_ENV !== "production" ? DataGridPremiumRaw.propTypes = {
    * If `true`, the Data Grid will auto span the cells over the rows having the same value.
    * @default false
    */
-  unstable_rowSpanning: PropTypes.bool
+  unstable_rowSpanning: PropTypes.bool,
+  /**
+   * If `true`, the Data Grid enables column virtualization when `getRowHeight` is set to `() => 'auto'`.
+   * By default, column virtualization is disabled when dynamic row height is enabled to measure the row height correctly.
+   * For datasets with a large number of columns, this can cause performance issues.
+   * The downside of enabling this prop is that the row height will be estimated based the cells that are currently rendered, which can cause row height change when scrolling horizontally.
+   * @default false
+   */
+  virtualizeColumnsWithAutoRowHeight: PropTypes.bool
 } : void 0;
 /**
  * Demos:

package/esm/components/index.js

@@ -1,4 +1,5 @@
 export * from "./GridExcelExportMenuItem.js";
 export * from "../material/icons.js";
 export * from "./GridColumnMenuAggregationItem.js";
+export * from "./promptControl/index.js";
 export { GridColumnMenuGroupingItem } from "./GridPremiumColumnMenu.js";