useDataGrid

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

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

info

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

Basic usage

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

http://localhost:3000/posts

Live previews only work with the latest documentation.

import React from "react";
import { useDataGrid, DataGrid, GridColumns, List } from "@pankod/refine-mui";

interface IPost {
    id: number;
    title: string;
    content: string;
    status: "published" | "draft" | "rejected";
}

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

    const columns = React.useMemo<GridColumns<IPost>>(
        () => [
            {
                field: "id",
                headerName: "ID",
                type: "number",
                width: 75,
            },
            { field: "title", headerName: "Title", minWidth: 400, flex: 1 },
            {
                field: "status",
                headerName: "Status",
                width: 120,
            },
        ],
        [],
    );

    return (
        <List>
            <DataGrid {...dataGridProps} columns={columns} autoHeight />
        </List>
    );
};

Pagination

The hook handles pagination by setting the paginationMode, page, onPageChange, pageSize, and onPageSizeChange props that are compatible with <DataGrid>.

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

info

To disable pagination, you can set hasPagination property to false which is true by default. If pagination is disabled, hideFooterPagination property will be sent as true with paginationMode, page, onPageChange, pageSize and onPageSizeChange set to undefined.

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

    const {
        paginationMode,
        page,
        onPageChange,
        pageSize,
        onPageSizeChange,
        ...restDataGridProps
    } = dataGridProps;

    return (
        <List>
            <DataGrid
                columns={columns}
                {...restDataGridProps}
                paginationMode={paginationMode}
                page={page}
                onPageChange={onPageChange}
                pageSize={pageSize}
                onPageSizeChange={onPageSizeChange}
                autoHeight
            />
        </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();

    const { sortingMode, sortModel, onSortModelChange, ...restDataGridProps } =
        dataGridProps;

    return (
        <List>
            <DataGrid
                columns={columns}
                {...restDataGridProps}
                sortingMode={sortingMode}
                sortModel={sortModel}
                onSortModelChange={onSortModelChange}
                autoHeight
            />
        </List>
    );
};

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

import {
    useDataGrid,
    DataGrid,
    GridColumns,
    List,
    Button,
    ButtonGroup,
} from "@pankod/refine-mui";

const columns: GridColumns = [
    {
        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} autoHeight />
        </List>
    );
};

tip

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} autoHeight />;

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();

    const {
        filterMode,
        filterModel,
        onFilterModelChange,
        ...restDataGridProps
    } = dataGridProps;

    return (
        <List>
            <DataGrid
                columns={columns}
                {...restDataGridProps}
                filterMode={filterMode}
                filterModel={filterModel}
                onFilterModelChange={onFilterModelChange}
                autoHeight
            />
        </List>
    );
};

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

import {
    useDataGrid,
    DataGrid,
    GridColumns,
    List,
    FormControlLabel,
    Checkbox,
} from "@pankod/refine-mui";

const columns: GridColumns = [
    {
        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} autoHeight />
        </List>
    );
};

tip

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} autoHeight />;

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

Realtime Updates

This feature is only available if you use a Live Provider.

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.

Refer to the liveProvider documentation for more information →

Properties

resource

Default: It reads the resource value from the current URL.

It will be passed to the getList method from the dataProvider as parameter via the useList hook. The parameter is usually used as an API endpoint path. It all depends on how to handle the resource in the getList method. See the creating a data provider section for an example of how resources are handled.

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

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",
});

initialCurrent

Default: 1

Sets the initial value of the page index.

useDataGrid({
    initialCurrent: 2, // This will cause the table to initially display the data for page 2, rather than the default of page 1
});

initialPageSize

Default: 10

Sets the initial value of the page size.

useDataGrid({
    initialPageSize: 20, // This will cause the table to initially display 20 rows per page, rather than the default of 10
});

initialSorter

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

useDataGrid({
    initialSorter: [
        {
            field: "title",
            order: "asc",
        },
    ],
});

permanentSorter

Sets the permanent value of the sorter. The permanentSorter 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 initialSorter prop.

useDataGrid({
    permanentSorter: [
        {
            field: "title",
            order: "asc",
        },
    ],
});

initialFilter

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

useDataGrid({
    initialFilter: [
        {
            field: "title",
            operator: "contains",
            value: "Foo",
        },
    ],
});

permanentFilter

Sets the permanent value of the filter. The permanentFilter 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 initialFilter prop.

useDataGrid({
    permanentFilter: [
        {
            field: "title",
            operator: "contains",
            value: "Foo",
        },
    ],
});

defaultSetFilterBehavior

Default: merge

The filtering behavior can be set to either "merge" or "replace".

• 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({
    defaultSetFilterBehavior: "replace",
});

hasPagination

Default: true

Determines whether to use server-side pagination or not.

useDataGrid({
    hasPagination: false,
});

syncWithLocation

Default: false

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.

Also, you can set this value globally on <Refine> component.

useDataGrid({
    syncWithLocation: true,
});

queryOptions

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

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

metaData

metaData is used following two purposes:

• To pass additional information to data provider methods.
• Generate GraphQL queries using plain JavaScript Objects (JSON). Please refer GraphQL for more information.

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

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

const myDataProvider = {
    //...
    getList: async ({
        resource,
        pagination,
        hasPagination,
        sort,
        filters,
        metaData,
    }) => {
        const headers = metaData?.headers ?? {};
        const url = `${apiUrl}/${resource}`;

        //...
        //...

        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 about live mode, please check Live / Realtime page.

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.

Return Values

dataGridProps

The props needed by the <DataGrid> component.

sortingMode

Default: server

Determines whether to use server-side sorting or not.

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}
    autoHeight
    onSortModelChange={(model, details) => {
        dataGridProps.onSortModelChange(model, details);
        // do something else
    }}
/>

filterMode

Default: server

Determines whether to use server-side filtering or not.

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}
    autoHeight
    onFilterModelChange={(model, details) => {
        dataGridProps.onFilterModelChange(model, details);
        // 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}
    autoHeight
    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.).

tableQueryResult

Returned values from useList hook.

sorter

Current sorter state.

setSorter

 (sorter: CrudSorting) => void;

A function to set current sorter state.

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;

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

FAQ

How can I handle relational data?

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

http://localhost:3000/posts

Live previews only work with the latest documentation.

import React from "react";
import { Option, useSelect } from "@pankod/refine-core";
import {
    useDataGrid,
    DataGrid,
    GridColumns,
    List,
    GridValueFormatterParams,
} from "@pankod/refine-mui";

import { ICategory, IPost } from "interfaces";

const PostsList: React.FC = () => {
    const { dataGridProps } = useDataGrid<IPost>({
        initialCurrent: 2,
        initialPageSize: 10,
        initialSorter: [
            {
                field: "title",
                order: "asc",
            },
        ],
        initialFilter: [
            {
                field: "status",
                operator: "eq",
                value: "draft",
            },
        ],
        syncWithLocation: true,
    });

    const {
        options,
        queryResult: { isLoading },
    } = useSelect<ICategory>({
        resource: "categories",
        hasPagination: false,
    });

    const columns = React.useMemo<GridColumns<IPost>>(
        () => [
            {
                field: "id",
                headerName: "ID",
                type: "number",
                width: 50,
            },
            { field: "title", headerName: "Title", minWidth: 400, flex: 1 },
            {
                field: "category.id",
                headerName: "Category",
                type: "singleSelect",
                headerAlign: "left",
                align: "left",
                minWidth: 250,
                flex: 0.5,
                valueOptions: options,
                valueFormatter: (params: GridValueFormatterParams<Option>) => {
                    return params.value;
                },
                renderCell: function render({ row }) {
                    if (isLoading) {
                        return "Loading...";
                    }

                    const category = options.find(
                        (item) =>
                            item.value.toString() ===
                            row.category.id.toString(),
                    );
                    return category?.label;
                },
            },
            {
                field: "status",
                headerName: "Status",
                minWidth: 120,
                flex: 0.3,
                type: "singleSelect",
                valueOptions: ["draft", "published", "rejected"],
            },
        ],
        [options, isLoading],
    );

    return (
        <List>
            <DataGrid
                {...dataGridProps}
                columns={columns}
                autoHeight
                rowsPerPageOptions={[10, 20, 30, 50, 100]}
            />
        </List>
    );
};

API

Properties

Type Parameters

Property	Desription	Type	Default
TData	Result data of the query. Extends BaseRecord	BaseRecord	BaseRecord
TError	Custom error object that extends HttpError	HttpError	HttpError
TSearchVariables	Values for search params		{}

Return values

Property	Description	Type
dataGridProps	MUI X <DataGrid> props	DataGridPropsType*
tableQueryResult	Result of the react-query's useQuery	QueryObserverResult<{`` data: TData[];`` total: number; },`` TError>
search	It sends the parameters it receives to its onSearch function	(value: TSearchVariables) => Promise<void>
current	Current page index state (returns undefined if pagination is disabled)	number | undefined
totalPage	Total page count (returns undefined if pagination is disabled)	number | undefined
setCurrent	A function that changes the current (returns undefined if pagination is disabled)	React.Dispatch<React.SetStateAction<number>> | undefined
pageSize	Current pageSize state (returns undefined if pagination is disabled)	number | undefined
setPageSize	A function that changes the pageSize (returns undefined if pagination is disabled)	React.Dispatch<React.SetStateAction<number>> | undefined
hideFooterPagination	Whether to hide the footer pagination or not. This value is only returned if hasPagination is set to false	boolean
sorter	Current sorting state	CrudSorting
setSorter	A function that accepts a new sorter state	(sorter: CrudSorting) => void
filters	Current filters state	CrudFilters
setFilters	A function that accepts a new filter state	(filters: CrudFilters) => void
createLinkForSyncWithLocation	A function create accessible links for syncWithLocation	(params: SyncWithLocationParams) => string;

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

VIEW SOURCE CODE →

RUN IN YOUR LOCAL

npm create refine-app@latest -- --example table-mui-use-data-grid