[DataGridPro] Use readonly array result for getTreeDataPath.

We do not try to modify the array after receiving it, so let's accept an immutable array. This is still compatible with existing usage of getTreeDataPath.
mui · Apr 26, 2024 · 857d7f2 · 857d7f2
1 parent dd20afe
commit 857d7f2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/x-data-grid-pro/src/models/dataGridProProps.ts b/packages/x-data-grid-pro/src/models/dataGridProProps.ts
@@ -167,7 +167,7 @@ export interface DataGridProPropsWithoutDefaultValue<R extends GridValidRowModel
    * @param {R} row The row from which we want the path.
    * @returns {string[]} The path to the row.
    */
-  getTreeDataPath?: (row: R) => string[];
+  getTreeDataPath?: (row: R) => ReadonlyArray<string>;
   /**
    * Callback fired when scrolling to the bottom of the grid viewport.
    * @param {GridRowScrollEndParams} params With all properties from [[GridRowScrollEndParams]].

diff --git a/packages/x-data-grid-pro/src/tests/treeData.DataGridPro.test.tsx b/packages/x-data-grid-pro/src/tests/treeData.DataGridPro.test.tsx
@@ -214,7 +214,7 @@ describe('<DataGridPro /> - Tree data', () => {
       ]);
       setProps({
         getTreeDataPath: (row) => [...row.name.split('.').reverse()],
-      } as DataGridProProps);
+      } as Pick<DataGridProProps, 'getTreeDataPath'>);
       expect(getColumnValues(1)).to.deep.equal([
         'A',
         'A.A',