Merge pull request #6060 from jvert/master

fix #6050 - type definition for Datagrid rowClick property doesn't allow for functions that return Promise<string>
marmelab · Mar 23, 2021 · 3e48fa5 · 3e48fa5
2 parents 9140b41 + 31a9076
commit 3e48fa5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 15 deletions.
diff --git a/packages/ra-ui-materialui/src/list/datagrid/Datagrid.tsx b/packages/ra-ui-materialui/src/list/datagrid/Datagrid.tsx
@@ -34,6 +34,7 @@ import DatagridLoading from './DatagridLoading';
 import DatagridBody, { PureDatagridBody } from './DatagridBody';
 import useDatagridStyles from './useDatagridStyles';
 import { ClassesOverride } from '../../types';
+import { RowClickFunction } from './DatagridRow';
 
 /**
  * The Datagrid component renders a list of records as a table.
@@ -355,12 +356,6 @@ Datagrid.propTypes = {
     isRowSelectable: PropTypes.func,
 };
 
-type RowClickFunction = (
-    id: Identifier,
-    basePath: string,
-    record: Record
-) => string;
-
 export interface DatagridProps extends Omit<TableProps, 'size' | 'classes'> {
     body?: ReactElement;
     classes?: ClassesOverride<typeof useDatagridStyles>;

diff --git a/packages/ra-ui-materialui/src/list/datagrid/DatagridBody.tsx b/packages/ra-ui-materialui/src/list/datagrid/DatagridBody.tsx
@@ -6,7 +6,7 @@ import classnames from 'classnames';
 import { shallowEqual } from 'react-redux';
 import { Identifier, Record, RecordMap } from 'ra-core';
 
-import DatagridRow, { PureDatagridRow } from './DatagridRow';
+import DatagridRow, { PureDatagridRow, RowClickFunction } from './DatagridRow';
 import useDatagridStyles from './useDatagridStyles';
 
 const DatagridBody: FC<DatagridBodyProps> = React.forwardRef(
@@ -98,12 +98,6 @@ DatagridBody.defaultProps = {
     row: <DatagridRow />,
 };
 
-type RowClickFunction = (
-    id: Identifier,
-    basePath: string,
-    record: Record
-) => string;
-
 export interface DatagridBodyProps extends Omit<TableBodyProps, 'classes'> {
     basePath?: string;
     classes?: ReturnType<typeof useDatagridStyles>;

diff --git a/packages/ra-ui-materialui/src/list/datagrid/DatagridRow.tsx b/packages/ra-ui-materialui/src/list/datagrid/DatagridRow.tsx
@@ -265,7 +265,7 @@ export type RowClickFunction = (
     id: Identifier,
     basePath: string,
     record: Record
-) => string;
+) => string | Promise<string>;
 
 const areEqual = (prevProps, nextProps) => {
     const { children: _1, expand: _2, ...prevPropsWithoutChildren } = prevProps;

diff --git a/packages/ra-ui-materialui/src/list/datagrid/index.ts b/packages/ra-ui-materialui/src/list/datagrid/index.ts
@@ -8,7 +8,11 @@ import DatagridHeaderCell, {
     DatagridHeaderCellProps,
 } from './DatagridHeaderCell';
 import DatagridLoading, { DatagridLoadingProps } from './DatagridLoading';
-import DatagridRow, { DatagridRowProps, PureDatagridRow } from './DatagridRow';
+import DatagridRow, {
+    DatagridRowProps,
+    PureDatagridRow,
+    RowClickFunction,
+} from './DatagridRow';
 import ExpandRowButton, { ExpandRowButtonProps } from './ExpandRowButton';
 import useDatagridStyles from './useDatagridStyles';
 
@@ -33,4 +37,5 @@ export type {
     DatagridLoadingProps,
     DatagridRowProps,
     ExpandRowButtonProps,
+    RowClickFunction,
 };