[data grid] Use readonly array for GridSortModel.

mui · Feb 18, 2025 · 65e1a28 · 65e1a28
1 parent fd4e5b2
commit 65e1a28
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/packages/x-data-grid/src/hooks/features/sorting/useGridSorting.ts b/packages/x-data-grid/src/hooks/features/sorting/useGridSorting.ts
@@ -188,7 +188,7 @@ export const useGridSorting = (
     (field, direction, allowMultipleSorting) => {
       const column = apiRef.current.getColumn(field);
       const sortItem = createSortItem(column, direction);
-      let sortModel: GridSortItem[];
+      let sortModel: GridSortModel;
       if (!allowMultipleSorting || props.disableMultipleColumnsSorting) {
         sortModel = sortItem?.sort == null ? [] : [sortItem];
       } else {

diff --git a/packages/x-data-grid/src/models/gridSortModel.ts b/packages/x-data-grid/src/models/gridSortModel.ts
@@ -37,4 +37,4 @@ export interface GridSortItem {
 /**
  * The model used for sorting the grid.
  */
-export type GridSortModel = GridSortItem[];
+export type GridSortModel = readonly GridSortItem[];
diff --git a/packages/x-data-grid/src/tests/DataGrid.spec.tsx b/packages/x-data-grid/src/tests/DataGrid.spec.tsx
@@ -277,3 +277,10 @@ function ApiRefProMethods() {
 
   return null;
 }
+
+function ImmutableProps() {
+  const rows = [] as const;
+  const columns = [] as const;
+  const initialState = { sorting: { sortModel: [{ field: 'id', sort: 'asc' }] } } as const;
+  return <DataGrid rows={rows} columns={columns} initialState={initialState} />;
+}