useDataGrid Hook | MUI Data Grid & Refine v4

import BasicUsagePreview from "./_partial-use-data-grid-basic-usage-live-preview.md"; import RelationalPreview from "./_partial-use-data-grid-relational-live-preview.md"; import PropResource from "@site/src/partials/prop-resource";

By using useDataGrid, you can get properties that are compatible with MUI X <DataGrid> component. All features such as sorting, filtering, and pagination come out of the box. Under the hood it uses useList for the fetch.

For all the other features, you can refer to the MUI X <DataGrid> documentation

:::simple Good to know

💡 The useDataGrid hook is compatible with both the <DataGrid> and the <DataGridPro> components.

This hook is extended from useTable from the @refinedev/core package. This means that you can use all the features of useTable hook.

:::

usage

In basic usage, useDataGrid returns the data as it comes from the endpoint. By default, it reads resource from the URL.

Pagination

The hook handles pagination by setting the paginationMode, paginationModel and onPaginationModelChange props that are compatible with <DataGrid>.

It also syncs the pagination state with the URL if you enable the syncWithLocation.

If you want to handle the pagination on client-side, you can pass the pagination.mode prop to the useDataGrid hook and set it to "client".

export const PostsList: React.FC = () => {
  const { dataGridProps } = useDataGrid();

  const {
    //highlight-start
    paginationMode,
    paginationModel,
    onPaginationModelChange,
    //highlight-end
    ...restDataGridProps
  } = dataGridProps;

  return (
    <List>
      <DataGrid
        columns={columns}
        {...restDataGridProps}
        //highlight-start
        paginationMode={paginationMode}
        paginationModel={paginationModel}
        onPaginationModelChange={onPaginationModelChange}
        //highlight-end
      />
    </List>
  );
};

Sorting

The hook handles sorting by setting the sortingMode, sortModel, and onSortModelChangeprops that are compatible with <DataGrid>.

It also syncs the sorting state with the URL if you enable the syncWithLocation.

export const PostsList: React.FC = () => {
  const { dataGridProps } = useDataGrid();

  //highlight-start
  const { sortingMode, sortModel, onSortModelChange, ...restDataGridProps } =
    dataGridProps;
  //highlight-end

  return (
    <List>
      <DataGrid
        columns={columns}
        {...restDataGridProps}
        //highlight-start
        sortingMode={sortingMode}
        sortModel={sortModel}
        onSortModelChange={onSortModelChange}
        //highlight-end
      />
    </List>
  );
};

If you want to sort externally from the <DataGrid> component. You can use setSorter like this:

import { useDataGrid, List } from "@refinedev/mui";
import { Button, ButtonGroup } from "@mui/material";
import { DataGrid, GridColDef } from "@mui/x-data-grid";

const columns: GridColDef[] = [
  {
    field: "id",
    headerName: "ID",
    type: "number",
  },
  { field: "title", headerName: "Title" },
  { field: "status", headerName: "Status" },
];

export const PostsList: React.FC = () => {
  const { dataGridProps, setSorter } = useDataGrid();

  const handleSorting = (order: "asc" | "desc") => {
    setSorter([
      {
        field: "title",
        order,
      },
    ]);
  };

  return (
    <List>
      <ButtonGroup variant="outlined">
        <Button onClick={() => handleSorting("asc")}>Asc</Button>
        <Button onClick={() => handleSorting("desc")}>Desc</Button>
      </ButtonGroup>
      <DataGrid {...dataGridProps} columns={columns} />
    </List>
  );
};

Mui X community version only sorts the rows according to one criterion at a time. To use multi-sorting, you need to upgrade to the Pro plan.

However, multiple sorting can be done server-side without specifying the sortModel.

return <DataGrid {...dataGridProps} sortModel={undefined} />;

When sortModel is not passed, it supports more than one criteria at a time, but cannot show which fields are sorted in <DataGrid> headers.

Filtering

The hook handles filtering by setting the filterMode, filterModel and onFilterModelChangeprops that are compatible with <DataGrid>.

It also syncs the filtering state with the URL if you enable the syncWithLocation.

export const PostsList: React.FC = () => {
  const { dataGridProps } = useDataGrid();

  //highlight-start
  const { filterMode, filterModel, onFilterModelChange, ...restDataGridProps } =
    dataGridProps;
  //highlight-end

  return (
    <List>
      <DataGrid
        columns={columns}
        {...restDataGridProps}
        //highlight-start
        filterMode={filterMode}
        filterModel={filterModel}
        onFilterModelChange={onFilterModelChange}
        //highlight-end
      />
    </List>
  );
};

If you want to filter externally from the <DataGrid> component. You can use setFilter like this:

import { useDataGrid, List } from "@refinedev/mui";
import { FormControlLabel, Checkbox } from "@mui/material";
import { DataGrid, GridColDef } from "@mui/x-data-grid";
const columns: GridColDef[] = [
  {
    field: "id",
    headerName: "ID",
    type: "number",
  },
  { field: "title", headerName: "Title" },
  { field: "status", headerName: "Status" },
];

export const PostsList: React.FC = () => {
  const { dataGridProps, setFilters } = useDataGrid();

  const handleFilter = (
    e: React.ChangeEvent<HTMLInputElement>,
    checked: boolean,
  ) => {
    setFilters([
      {
        field: "status",
        value: checked ? "draft" : undefined,
        operator: "eq",
      },
    ]);
  };

  return (
    <List>
      <FormControlLabel
        label="Filter by Draft Status"
        control={<Checkbox onChange={handleFilter} />}
      />
      <DataGrid {...dataGridProps} columns={columns} />
    </List>
  );
};

Mui X community version only filters the rows according to one criterion at a time. To use multi-filtering, you need to upgrade to the Pro plan.

However, multiple filtering can be done server-side without specifying the filterModel.

return <DataGrid {...dataGridProps} filterModel={undefined} />;

When filterModel is not passed, it supports more than one criteria at a time, but cannot show which fields are filtered in <DataGrid> headers.

:::simple Finding the filter value

Refine provides the getDefaultFilter function, You can use this function to find the filter value for the specific field.

import { getDefaultFilter } from "@refinedev/core";
import { useDataGrid } from "@refinedev/mui";

const MyComponent = () => {
  const { filters } = useDataGrid({
    filters: {
      initial: [
        {
          field: "name",
          operator: "contains",
          value: "John Doe",
        },
      ],
    },
  });

  const nameFilterValue = getDefaultFilter("name", filters, "contains");
  console.log(nameFilterValue); // "John Doe"

  return {
    /** ... */
  };
};

:::

Realtime Updates

LiveProvider is required for this prop to work.

When the useDataGrid hook is mounted, it will call the subscribe method from the liveProvider with some parameters such as channel, resource etc. It is useful when you want to subscribe to live updates.

Editing

The useDataGrid hook extends the editing capabilities provided by the <DataGrid> component from MUI. To enable column editing, set editable: "true" on specific column definitions.

useDataGrid leverages useUpdate for direct integration with update operations. This change enhances performance and simplifies the interaction model by directly using the update mechanisms provided by Refine.

Here is how you can define columns to be editable:

const columns = React.useMemo<GridColDef<IPost>[]>(
  () => [
    {
      field: "title",
      headerName: "Title",
      minWidth: 400,
      flex: 1,
      editable: true,
    },
  ],
  [],
);

Handling Updates

With the integration of useUpdate, processRowUpdate from <DataGrid> directly interacts with the backend. This method attempts to update the row with the new values, handling the update logic internally.

The hook now simplifies the handling of updates by removing the need for managing form state transitions explicitly:

const {
  dataGridProps,
  formProps: { processRowUpdate, formLoading },
} = useDataGrid<IPost>();

By default, when a cell edit is initiated and completed, the processRowUpdate function will be triggered, which will now use the mutate function from useUpdate to commit changes.

const processRowUpdate = async (newRow: TData, oldRow: TData) => {
  try {
    await new Promise((resolve, reject) => {
      mutate(
        {
          resource: resourceFromProp as string,
          id: newRow.id as string,
          values: newRow,
        },
        {
          onError: (error) => {
            reject(error);
          },
          onSuccess: (data) => {
            resolve(data);
          },
        },
      );
    });
    return newRow;
  } catch (error) {
    return oldRow;
  }
};

Properties

resource

<PropResource hook={{ name:"useList", URL:"/docs/data/hooks/use-list" }} method={{ name:"getList", URL:"/docs/data/data-provider/#getlist" }} hasDefault={false} />

By default, resource will be inferred from the current route.

useDataGrid({
  resource: "categories",
});

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier section of the <Refine/> component documentation &#8594

dataProviderName

If there is more than one dataProvider, you should use the dataProviderName that you will use. It is useful when you want to use a different dataProvider for a specific resource.

useDataGrid({
  dataProviderName: "second-data-provider",
});

pagination.current

Sets the initial value of the page index. Default value is 1.

useDataGrid({
  pagination: {
    current: 2,
  },
});

pagination.pageSize

Sets the initial value of the page size. It is 25 by default.

useDataGrid({
  pagination: {
    pageSize: 10,
  },
});

pagination.mode

It can be "off", "server" or "client". It is "server" by default.

• "off": Pagination is disabled. All records will be fetched.
• "client": Pagination is done on the client side. All records will be fetched and then the records will be paginated on the client side.
• "server":: Pagination is done on the server side. Records will be fetched by using the current and pageSize values.

useDataGrid({
  pagination: {
    mode: "client",
  },
});

sorters.initial

sorters.initial sets the initial value of the sorter. The initial is not permanent. It will be cleared when the user changes the sorter. If you want to set a permanent value, use the sorters.permanent prop.

For more information, refer to the CrudSorting interface documentation &#8594

useDataGrid({
  sorters: {
    initial: [
      {
        field: "name",
        order: "asc",
      },
    ],
  },
});

sorters.permanent

sorters.permanent sets the permanent value of the sorter. The permanent is permanent and unchangeable. It will not be cleared when the user changes the sorter. If you want to set a temporary value, use the sorters.initial prop.

For more information, refer to the CrudSorting interface documentation &#8594

useDataGrid({
  sorters: {
    permanent: [
      {
        field: "name",
        order: "asc",
      },
    ],
  },
});

sorters.mode

It can be "off", or "server". It is "server" by default.

• "off": sorters are not sent to the server. You can use the sorters value to sort the records on the client side.
• "server":: Sorting is done on the server side. Records will be fetched by using the sorters value.

useDataGrid({
  sorters: {
    mode: "server",
  },
});

filters.initial

Sets the initial value of the filter. The initial is not permanent. It will be cleared when the user changes the filter. If you want to set a permanent value, use the filters.permanent prop.

For more information, refer to the CrudFilters interface documentation &#8594

useDataGrid({
  filters: {
    initial: [
      {
        field: "name",
        operator: "contains",
        value: "Foo",
      },
    ],
  },
});

filters.permanent

Sets the permanent value of the filter. The permanent is permanent and unchangeable. It will not be cleared when the user changes the filter. If you want to set a temporary value, use the filters.initial prop.

For more information, refer to the CrudFilters interface documentation &#8594

useDataGrid({
  filters: {
    permanent: [
      {
        field: "name",
        operator: "contains",
        value: "Foo",
      },
    ],
  },
});

filters.defaultBehavior

The filtering behavior can be set to either "merge" or "replace". It is "merge" by default.

• When the filter behavior is set to "merge", it will merge the new filter with the existing filters. This means that if the new filter has the same column as an existing filter, the new filter will replace the existing filter for that column. If the new filter has a different column than the existing filters, it will be added to the existing filters.

• When the filter behavior is set to "replace", it will replace all existing filters with the new filter. This means that any existing filters will be removed and only the new filter will be applied to the table.

You can also override the default value by using the second parameter of the setFilters function.

useDataGrid({
  filters: {
    defaultBehavior: "replace",
  },
});

filters.mode

It can be "off" or "server". It is "server" by default.

• "off": filters are not sent to the server. You can use the filters value to filter the records on the client side.
• "server":: Filters are done on the server side. Records will be fetched by using the filters value.

useDataGrid({
  filters: {
    mode: "off",
  },
});

syncWithLocation <GlobalConfigBadge id="core/refine-component/#syncwithlocation" />

When you use the syncWithLocation feature, the useDataGrid's state (e.g. sort order, filters, pagination) is automatically encoded in the query parameters of the URL, and when the URL changes, the useDataGrid state is automatically updated to match. This makes it easy to share table states across different routes or pages and allows users to bookmark or share links to specific table views. It is false by default.

useDataGrid({
  syncWithLocation: true,
});

queryOptions

useDataGrid uses useList hook to fetch data. You can pass queryOptions.

useDataGrid({
  queryOptions: {
    retry: 3,
  },
});

meta

meta is a special property that can be used to pass additional information to data provider methods for the following purposes:

• Customizing the data provider methods for specific use cases.
• Generating GraphQL queries using plain JavaScript Objects (JSON).

For more information, refer to the meta section of the General Concepts documentation for more information &#8594

In the following example, we pass the headers property in the meta object to the create method. With similar logic, you can pass any properties to specifically handle the data provider methods.

useDataGrid({
  meta: {
    headers: { "x-meta-data": "true" },
  },
});

const myDataProvider = {
  //...
  getList: async ({
    resource,
    pagination,
    sorters,
    filters,
    // highlight-next-line
    meta,
  }) => {
    // highlight-next-line
    const headers = meta?.headers ?? {};
    const url = `${apiUrl}/${resource}`;

    //...
    //...

    // highlight-next-line
    const { data, headers } = await httpClient.get(`${url}`, { headers });

    return {
      data,
    };
  },
  //...
};

successNotification

NotificationProvider is required for this prop to work.

After data is fetched successfully, useDataGrid can call open function from NotificationProvider to show a success notification. With this prop, you can customize the success notification.

useDataGrid({
  successNotification: (data, values, resource) => {
    return {
      message: `${data.title} Successfully fetched.`,
      description: "Success with no errors",
      type: "success",
    };
  },
});

errorNotification

NotificationProvider is required for this prop to work.

After data fetching is failed, useDataGrid will call open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

useDataGrid({
  errorNotification: (data, values, resource) => {
    return {
      message: `Something went wrong when getting ${data.id}`,
      description: "Error",
      type: "error",
    };
  },
});

liveMode

LiveProvider is required for this prop to work.

Determines whether to update data automatically ("auto") or not ("manual") if a related live event is received. It can be used to update and show data in Realtime throughout your app.

For more information, please refer to the Live / Realtime documentation

useDataGrid({
  liveMode: "auto",
});

onLiveEvent

LiveProvider is required for this prop to work.

The callback function is executed when new events from a subscription have arrived.

useDataGrid({
  onLiveEvent: (event) => {
    console.log(event);
  },
});

liveParams

LiveProvider is required for this prop to work.

Params to pass to liveProvider's subscribe method.

overtimeOptions

If you want loading overtime for the request, you can pass the overtimeOptions prop to the this hook. It is useful when you want to show a loading indicator when the request takes too long. interval is the time interval in milliseconds while onInterval is the function that will be called on each interval.

Return overtime object from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useDataGrid({
  //...
  overtimeOptions: {
    interval: 1000,
    onInterval(elapsedInterval) {
      console.log(elapsedInterval);
    },
  },
});

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

// You can use it like this:
{
  elapsedTime >= 4000 && <div>this takes a bit longer than expected</div>;
}

initialCurrent <PropTag deprecated />

Use pagination.current instead.

initialPageSize <PropTag deprecated />

Use pagination.pageSize instead.

hasPagination <PropTag deprecated />

Use pagination.mode instead.

initialSorter <PropTag deprecated />

Use sorters.initial instead.

permanentSorter <PropTag deprecated />

Use sorters.permanent instead.

initialFilter <PropTag deprecated />

Use filters.initial instead.

permanentFilter <PropTag deprecated />

Use filters.permanent instead.

defaultSetFilterBehavior <PropTag deprecated />

Use filters.defaultBehavior instead.

Return Values

dataGridProps

The props needed by the <DataGrid> component.

sortingMode

Determines whether to use server-side sorting or not. It is server by default.

sortModel

Current GridSortModel compatible with <DataGrid> component.

onSortModelChange

When the user sorts a column, this function is called with the new sort model.

dataGridProps.onSortModelChange automatically transform GridSortModel to CrudSorting and call setSorter function. If you want to override it, you can use like this:

<DataGrid
  {...dataGridProps}
  columns={columns}
  onSortModelChange={(model, details) => {
    dataGridProps.onSortModelChange(model, details);
    // do something else
  }}
/>

filterMode

Determines whether to use server-side filtering or not. It is server by default.

filterModel

Current GridFilterModel compatible with <DataGrid> component.

onFilterModelChange

When the user filters a column, this function is called with the new filter model.

dataGridProps.onFilterModelChange automatically transform GridFilterModel to CrudFilters and call setFilters function. If you want to override it, you can use like this:

<DataGrid
  {...dataGridProps}
  columns={columns}
  onFilterModelChange={(model) => {
    dataGridProps.onFilterModelChange(model);
    // do something else
  }}
/>

onStateChange

When the user sorts or filters a column, this function is called with the new state.

The onStateChange callback is used internally by the useDataGrid hook. If you want to override it, you can use like this:

<DataGrid
  {...dataGridProps}
  columns={columns}
  onStateChange={(state) => {
    dataGridProps.onStateChange(state);
    // do something else
  }}
/>

rows

Contains the data to be displayed in the data grid. Values fetched with useList hook.

rowCount

Total number of data. Value fetched with useList hook.

loading

Indicates whether the data is being fetched.

pagination

Returns pagination configuration values(pageSize, current, setCurrent, etc.).

tableQuery

Returned values from useList hook.

sorters

Current sorters state.

setSorters

A function to set current sorters state.

 (sorters: CrudSorting) => void;

filters

Current filters state.

setFilters

((filters: CrudFilters, behavior?: SetFilterBehavior) => void) & ((setter: (prevFilters: CrudFilters) => CrudFilters) => void)

A function to set current filters state.

current

Current page index state. If pagination is disabled, it will be undefined.

setCurrent

React.Dispatch<React.SetStateAction<number>> | undefined;

A function to set the current page index state. If pagination is disabled, it will be undefined.

pageSize

Current page size state. If pagination is disabled, it will be undefined.

setPageSize

React.Dispatch<React.SetStateAction<number>> | undefined;

A function to set the current page size state. If pagination is disabled, it will be undefined.

pageCount

Total page count state. If pagination is disabled, it will be undefined.

createLinkForSyncWithLocation

(params: SyncWithLocationParams) => string;

overtime

overtime object is returned from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useDataGrid();

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

A function creates accessible links for syncWithLocation. It takes SyncWithLocationParams as parameters.

sorter <PropTag deprecated />

Use sorters instead.

setSorter <PropTag deprecated />

Use setSorters instead.

tableQueryResult <PropTag deprecated />

Use tableQuery instead.

FAQ

How can I handle relational data?

You can use useSelect hook to fetch relational data and filter <DataGrid> by categories.

How can I handle client side filtering?

You can set the filters.mode: "off" in order to disable server-side filtering. useDataGrid is fully compatible with Material UI <DataGrid> component's filtering feature.

useDataGrid({
  filters: {
    mode: "off",
  },
});

How can I handle client side sorting?

You can set the sorting.mode: "off" in order to disable server-side sorting. useDataGrid is fully compatible with Material UI <DataGrid> component's sorting feature.

useDataGrid({
  sorting: {
    mode: "off",
  },
});

API

Properties

Type Parameters

Return values

DataGridProps

Property	Default	Property	Default
rows	[]	pageSize	25
rowCount	0	onPageSizeChange
disableSelectionOnClick	true	sortingMode	"server"
loading	false	sortModel
paginationMode	"server"	onSortModelChange
page	0	filterMode	"server"
onPageChange		filterModel
onStateChange		onFilterModelChange

Example