[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 · Jan 18, 2024 · 982d960 · 982d960
1 parent c710c86
commit 982d960
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx b/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx
@@ -418,7 +418,7 @@ DataGridPremiumRaw.propTypes = {
    * Note that all paths must contain at least one element.
    * @template R
    * @param {R} row The row from which we want the path.
-   * @returns {string[]} The path to the row.
+   * @returns {readonly string[]} The path to the row.
    */
   getTreeDataPath: PropTypes.func,
   /**

diff --git a/packages/grid/x-data-grid-pro/src/models/dataGridProProps.ts b/packages/grid/x-data-grid-pro/src/models/dataGridProProps.ts
@@ -186,7 +186,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) => readonly string[];
   /**
    * Callback fired while a column is being resized.
    * @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].