Skip to main content
RefineDocumentation
Version: 3.xx.xx
Source Code

useTable

useTable allows us to fetch data according to the sorter, filter, and pagination states. Under the hood it uses useList for the fetch. Since it is designed as headless, It expects you to handle the UI.

INFORMATION

If you're looking for a complete table library, Refine supports two table libraries out of the box.

Basic Usage​

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

localhost:3000/posts
Live previews only work with the latest documentation.
import React from "react";
import {
    IResourceComponentsProps,
    useTable,
    HttpError,
} from "@pankod/refine-core";

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

const PostList: React.FC<IResourceComponentsProps> = () => {
    const { tableQueryResult } = useTable<IPost, HttpError>();
    const posts = tableQueryResult?.data?.data ?? [];

    if (tableQueryResult?.isLoading) {
        return <div>Loading...</div>;
    }

    return (
        <div>
            <h1>Posts</h1>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Created At</th>
                    </tr>
                </thead>
                <tbody>
                    {posts.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>{new Date(post.createdAt).toDateString()}</td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

Pagination​

useTable has a pagination feature. The pagination is done by using the current and pageSize props. The current is the current page and the pageSize is the number of records per page.

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

By default, the current is 1 and the pageSize is 10. You can change default values by passing the initialCurrent and initialPageSize props to the useTable hook.

You can also change the current and pageSize values by using the setCurrent and setPageSize functions that are returned by the useTable hook. Every change will trigger a new fetch.

If you want to disable pagination, you can use hasPagination property in useTable config and set it to false

INFORMATION

If hasPagination is set to false, current, setCurrent, pageSize, setPageSize, and pageCount will return undefined

localhost:3000/posts
Live previews only work with the latest documentation.
import React from "react";
import {
    IResourceComponentsProps,
    useMany,
    useTable,
    HttpError,
} from "@pankod/refine-core";

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

const PostList: React.FC<IResourceComponentsProps> = () => {
    const {
        tableQueryResult,
        current,
        setCurrent,
        pageSize,
        setPageSize,
        pageCount,
    } = useTable<IPost, HttpError>();

    // Fetches the posts for the current page
    const posts = tableQueryResult?.data?.data ?? [];
    // Checks if there is a next page available
    const hasNext = current < pageCount;
    // Checks if there is a previous page available
    const hasPrev = current > 1;

    return (
        <div>
            <h1>Posts</h1>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Created At</th>
                    </tr>
                </thead>
                <tbody>
                    {tableQueryResult.data?.data.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>{new Date(post.createdAt).toDateString()}</td>
                        </tr>
                    ))}
                </tbody>
            </table>
            <div
                style={{
                    display: "flex",
                    gap: "1rem",
                    alignItems: "center",
                }}
            >
                <div>
                    <button onClick={() => setCurrent(1)} disabled={!hasPrev}>
                        First
                    </button>
                    <button
                        onClick={() => setCurrent((prev) => prev - 1)}
                        disabled={!hasPrev}
                    >
                        Previous
                    </button>
                    <button
                        onClick={() => setCurrent((prev) => prev + 1)}
                        disabled={!hasNext}
                    >
                        Next
                    </button>
                    <button
                        onClick={() => setCurrent(pageCount)}
                        disabled={!hasNext}
                    >
                        Last
                    </button>
                </div>
                <span>
                    Page{" "}
                    <strong>
                        {current} of {pageCount}
                    </strong>
                </span>
                <span>
                    Go to page:
                    <input
                        type="number"
                        defaultValue={current + 1}
                        onChange={(e) => {
                            const value = e.target.value
                                ? Number(e.target.value)
                                : 1;
                            setCurrent(value);
                        }}
                    />
                </span>
                <select
                    value={pageSize}
                    onChange={(e) => {
                        const value = e.target.value
                            ? Number(e.target.value)
                            : 10;
                        setPageSize(value);
                    }}
                >
                    {[10, 20, 30, 40, 50].map((size) => (
                        <option key={size} value={size}>
                            Show {size}
                        </option>
                    ))}
                </select>
            </div>
        </div>
    );
};

Sorting​

useTable has a sorter feature. The sorter is done by using the sorter state. The sorter state is a CrudSorting type that contains the field and the order of the sort. You can change the sorter state by using the setSorter function. Every change will trigger a new fetch.

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

Also, you can add an initial sorter state by passing the initialSorter prop and a permanent sorter state by passing the permanentSorter prop to the useTable hook. Even if you change the sorter state, the permanentSorter will be used together with the sorter state.

localhost:3000/posts
Live previews only work with the latest documentation.
import React, { useMemo } from "react";
import {
    IResourceComponentsProps,
    useMany,
    useTable,
    HttpError,
} from "@pankod/refine-core";

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

const PostList: React.FC<IResourceComponentsProps> = () => {
    const { tableQueryResult, sorter, setSorter } = useTable<IPost, HttpError>({
        initialSorter: [
            {
                field: "createdAt",
                order: "desc",
            },
        ],
    });

    // Fetches the posts for the current page
    const posts = tableQueryResult?.data?.data ?? [];

    // Gets the current sort order for the fields
    const currentSorterOrders = useMemo(() => {
        return {
            createdAt:
                sorter.find((item) => item.field === "createdAt")?.order ||
                "desc",
            id: sorter.find((item) => item.field === "id")?.order || "desc",
            title:
                sorter.find((item) => item.field === "title")?.order || "asc",
        };
    }, [sorter]);

    const toggleSort = (field: string) => {
        setSorter([
            {
                field,
                order: currentSorterOrders[field] === "asc" ? "desc" : "asc",
            },
        ]);
    };

    return (
        <div>
            <div
                style={{
                    display: "flex",
                    gap: "1rem",
                    alignItems: "center",
                    marginBottom: "1rem",
                }}
            >
                <button onClick={() => toggleSort("createdAt")}>
                    Sort date by{" "}
                    {currentSorterOrders["createdAt"] === "asc"
                        ? "desc"
                        : "asc"}
                </button>
                <button onClick={() => toggleSort("id")}>
                    Sort id by{" "}
                    {currentSorterOrders["id"] === "asc" ? "desc" : "asc"}
                </button>
                <button onClick={() => toggleSort("title")}>
                    Sort title by{" "}
                    {currentSorterOrders["title"] === "asc" ? "desc" : "asc"}
                </button>
            </div>
            <h1>Posts</h1>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Created At</th>
                    </tr>
                </thead>
                <tbody>
                    {tableQueryResult.data?.data.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>{new Date(post.createdAt).toDateString()}</td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

Filtering​

useTable has a filter feature. The filter is done by using the filters state. The filters state is a CrudFilters type that contains the field, the operator, and the value of the filter. You can change the filter state by using the setFilters function. Every change will trigger a new fetch.

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

Also you can add an initial filter state by passing the initialFilter prop and a permanent filter state by passing the permanentFilter prop to the useTable hook. Even if you change the filter state, the permanentFilter will be used together with the filter state.

setFilters function can work in two different behaviors; merge (default) and replace. You can set the behavior by passing it as the 2nd parameter. You can change the default behavior with defaultSetFilterBehavior prop.

You can also call setFilters with a setter function.

INFORMATION

If you are using merge behavior and want to remove one of the filters; you should set the value to undefined or null. For or filters, you should set the value to an empty array [] to remove the filter.

localhost:3000/posts
Live previews only work with the latest documentation.
import React, { useMemo } from "react";
import {
    IResourceComponentsProps,
    useMany,
    useTable,
    HttpError,
} from "@pankod/refine-core";

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

const PostList: React.FC<IResourceComponentsProps> = () => {
    const { tableQueryResult, filters, setFilters } = useTable<
        IPost,
        HttpError
    >();

    // Fetches the posts for the current page
    const posts = tableQueryResult?.data?.data ?? [];

    // Gets the current filter values for the fields
    const currentFilterValues = useMemo(() => {
        // Filters can be a LogicalFilter or a ConditionalFilter. ConditionalFilter not have field property. So we need to filter them.
        // We use flatMap for better type support.
        const logicalFilters = filters.flatMap((item) =>
            "field" in item ? item : [],
        );

        return {
            title:
                logicalFilters.find((item) => item.field === "title")?.value ||
                "",
            id: logicalFilters.find((item) => item.field === "id")?.value || "",
            status:
                logicalFilters.find((item) => item.field === "status")?.value ||
                "",
        };
    }, [filters]);

    return (
        <div>
            <div
                style={{
                    display: "flex",
                    gap: "1rem",
                    alignItems: "center",
                    marginBottom: "4px",
                }}
            >
                <input
                    placeholder="Search by title"
                    value={currentFilterValues.title}
                    onChange={(e) => {
                        setFilters([
                            {
                                field: "title",
                                operator: "contains",
                                value: !!e.currentTarget.value
                                    ? e.currentTarget.value
                                    : undefined,
                            },
                        ]);
                    }}
                />
                <input
                    placeholder="Search by id"
                    value={currentFilterValues.id}
                    onChange={(e) => {
                        setFilters([
                            {
                                field: "id",
                                operator: "eq",
                                value: !!e.currentTarget.value
                                    ? e.currentTarget.value
                                    : undefined,
                            },
                        ]);
                    }}
                />

                <select
                    value={currentFilterValues.status}
                    onChange={(e) =>
                        setFilters(
                            [
                                {
                                    field: "status",
                                    operator: "eq",
                                    value: !!e.currentTarget.value
                                        ? e.currentTarget.value
                                        : undefined,
                                },
                            ],
                            "replace",
                        )
                    }
                >
                    <option value="">All</option>
                    <option value="published">Published</option>
                    <option value="draft">Draft</option>
                    <option value="rejected">Rejected</option>
                </select>
            </div>
            <h1>Posts</h1>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Created At</th>
                    </tr>
                </thead>
                <tbody>
                    {tableQueryResult.data?.data.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>{new Date(post.createdAt).toDateString()}</td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

Realtime Updates​

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

When the useTable 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.

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

initialCurrent​

Default: 1

Sets the initial value of the page index.

useTable({
  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.

useTable({
  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.

useTable({
  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.

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

initialFilter​

Type: CrudFilter[]

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.

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

permanentFilter​

Type: CrudFilter[]

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.

useTable({
  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.

useTable({
  defaultSetFilterBehavior: "replace",
});

hasPagination​

Default: true

Determines whether to use server-side pagination or not.

useTable({
  hasPagination: false,
});

syncWithLocation​

Default: false

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

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

useTable({
  syncWithLocation: true,
});

queryOptions​

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

useTable({
  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.

useTable({
  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, useTable can call open function from NotificationProvider to show a success notification. With this prop, you can customize the success notification.

useTable({
  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, useTable will call open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

useTable({
  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.

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

onLiveEvent​

LiveProvider is required for this prop to work.

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

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

liveParams​

LiveProvider is required for this prop to work.

Params to pass to liveProvider's subscribe method.

Return Values​

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 useMany hook to fetch relational data.

localhost:3000/posts
Live previews only work with the latest documentation.
import React from "react";
import {
    IResourceComponentsProps,
    useTable,
    useMany,
    HttpError,
} from "@pankod/refine-core";

interface ICategory {
    id: number;
    title: string;
}

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

const PostList: React.FC<IResourceComponentsProps> = () => {
    const { tableQueryResult } = useTable<IPost, HttpError>();
    const posts = tableQueryResult?.data?.data ?? [];

    // Fetches the category of each post. It uses the useMany hook to fetch the category data from the API.
    const { data: categoryData, isLoading: categoryIsLoading } = useMany<
        ICategory,
        HttpError
    >({
        resource: "categories",
        // Creates the array of ids. This will filter and fetch the category data for the relevant posts.
        ids: posts.map((item) => item?.category?.id),
        queryOptions: {
            // Set to true only if the posts array is not empty.
            enabled: !!posts.length,
        },
    });

    if (tableQueryResult?.isLoading) {
        return <div>Loading...</div>;
    }

    return (
        <div>
            <h1>Posts</h1>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Created At</th>
                        <th>Category</th>
                    </tr>
                </thead>
                <tbody>
                    {posts.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>{new Date(post.createdAt).toDateString()}</td>
                            <td>
                                {categoryIsLoading
                                    ? "loading..."
                                    : // Gets the title of the category from the categoryData object, which is the result of    the useMany hook.
                                      categoryData?.data.find(
                                          (item) =>
                                              item.id === post.category.id,
                                      )?.title || "-"}
                            </td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

API​

Properties​

Type Parameters​

PropertyDesriptionTypeDefault
TDataResult data of the query. Extends BaseRecordBaseRecordBaseRecord
TErrorCustom error object that extends HttpErrorHttpErrorHttpError

Return values​

PropertyDescriptionType
tableQueryResultResult of the react-query's useQueryQueryObserverResult<{`` data: TData[];`` total: number; },`` TError>
currentCurrent page index state (returns undefined if pagination is disabled)number | undefined
pageCountTotal page count (returns undefined if pagination is disabled)number | undefined
setCurrentA function that changes the current (returns undefined if pagination is disabled)React.Dispatch<React.SetStateAction<number>> | undefined
pageSizeCurrent pageSize state (returns undefined if pagination is disabled)number | undefined
setPageSizeA function that changes the pageSize. (returns undefined if pagination is disabled)React.Dispatch<React.SetStateAction<number>> | undefined
sorterCurrent sorting state sCrudSorting
setSorterA function that accepts a new sorter state.(sorter: CrudSorting) => void
filtersCurrent filters stateCrudFilters
setFiltersA function that accepts a new filter state- (filters: CrudFilters, behavior?: "merge" \| "replace" = "merge") => void - (setter: (previousFilters: CrudFilters) => CrudFilters) => void
createLinkForSyncWithLocationA function create accessible links for syncWithLocation(params: SyncWithLocationParams) => string;
Previous
useShow
Next
useGetLocale