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 to be headless, it expects you to handle the UI.

Extended Versions:

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

React Table (for Headless, Chakra UI, Mantine) - Documentation - Example
Ant Design Table - Documentation - Example
Material UI Table - Documentation - Example

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

import React from "react";
import { useTable, HttpError } from "@refinedev/core";

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

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

  if (tableQuery?.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 passing the current and pageSize keys to pagination object. 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 pagination.current and pagination.pageSize 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.

By default, pagination happens on the server side. If you want to do pagination handling on the client side, you can pass the pagination.mode property and set it to "client". Also, you can disable the pagination by setting it to "off".

localhost:3000/posts

import React from "react";
import { useMany, useTable, HttpError } from "@refinedev/core";

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

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

  // Fetches the posts for the current page
  const posts = tableQuery?.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>
          {tableQuery.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 initial and permanent keys to sorters object. The initial is the initial sorter state, and the permanent is the permanent sorter state. These states are a CrudSorter type that contains the field and the order of the sorter.

You can change the sorters state by using the setSorters function. Every change will trigger a new fetch.

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

localhost:3000/posts

import React, { useMemo } from "react";
import { useMany, useTable, HttpError } from "@refinedev/core";

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

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

  // Fetches the posts for the current page
  const posts = tableQuery?.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>
          {tableQuery.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 initial, permanent and defaultBehavior keys to filters object. The initial is the initial filter state, and the permanent is the permanent filter state. These states are a CrudFilter type that contains the field, the operator, and the value of the filter.

You can change the filters 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.

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

Merge behavior:

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.

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, useTable } from "@refinedev/core";

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

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

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

localhost:3000/posts

import React, { useMemo } from "react";
import { useMany, useTable, HttpError } from "@refinedev/core";

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

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

  // Fetches the posts for the current page
  const posts = tableQuery?.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>
          {tableQuery.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

LiveProvider is required for this prop to work.

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.

Properties

resource

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.

By default, it will try to read the resource value from the current URL.

import { useTable } from "@refinedev/core";
useTable({
  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 of the <Refine/> component documentation →

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.

import { useTable } from "@refinedev/core";
useTable({
  dataProviderName: "second-data-provider",
});

pagination.current

Sets the initial value of the page index. Defaults to 1.

import { useTable } from "@refinedev/core";
useTable({
  pagination: {
    current: 2,
  },
});

pagination.pageSize

Sets the initial value of the page size. Defaults to 10.

import { useTable } from "@refinedev/core";
useTable({
  pagination: {
    pageSize: 20,
  },
});

pagination.mode

It can be "off", "server" or "client". Defaults to "server".

"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.

import { useTable } from "@refinedev/core";
useTable({
  pagination: {
    mode: "client",
  },
});

sorters.mode

It can be "off", or "server". Defaults to "server".

"off": sorters do not get 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.

import { useTable } from "@refinedev/core";
useTable({
  sorters: {
    mode: "server",
  },
});

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.

import { useTable } from "@refinedev/core";
useTable({
  sorters: {
    initial: [
      {
        field: "name",
        order: "asc",
      },
    ],
  },
});

For more information, refer to the CrudSorting interface→

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.

import { useTable } from "@refinedev/core";
useTable({
  sorters: {
    permanent: [
      {
        field: "name",
        order: "asc",
      },
    ],
  },
});

For more information, refer to the CrudSorting interface →

filters.mode

It can be "off" or "server". Defaults to "server".

"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.

import { useTable } from "@refinedev/core";
useTable({
  filters: {
    mode: "off",
  },
});

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.

import { useTable } from "@refinedev/core";
useTable({
  filters: {
    initial: [
      {
        field: "name",
        operator: "contains",
        value: "Foo",
      },
    ],
  },
});

For more information, refer to the CrudFilters interface →

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.

import { useTable } from "@refinedev/core";
useTable({
  filters: {
    permanent: [
      {
        field: "name",
        operator: "contains",
        value: "Foo",
      },
    ],
  },
});

For more information, refer to the CrudFilters interface →

filters.defaultBehavior

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

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.

import { useTable } from "@refinedev/core";
useTable({
  filters: {
    defaultBehavior: "replace",
  },
});

syncWithLocation
Globally Configurable
This value can be configured globally. Click to see the guide for more information.

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. By default, this feature is disabled.

import { useTable } from "@refinedev/core";
useTable({
  syncWithLocation: true,
});

queryOptions

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

import { useTable } from "@refinedev/core";
useTable({
  queryOptions: {
    retry: 3,
  },
});

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.

import { useTable } from "@refinedev/core";
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.

import { useTable } from "@refinedev/core";
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.

import { useTable } from "@refinedev/core";
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.

import { useTable } from "@refinedev/core";
useTable({
  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. 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.

import { useTable } from "@refinedev/core";
const { overtime } = useTable({
  //...
  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
deprecated

Use pagination.current instead.

initialPageSize
deprecated

Use pagination.pageSize instead.

hasPagination
deprecated

Use pagination.mode instead.

initialSorter
deprecated

Use sorters.initial instead.

permanentSorter
deprecated

Use sorters.permanent instead.

initialFilter
deprecated

Use filters.initial instead.

permanentFilter
deprecated

Use filters.permanent instead.

defaultSetFilterBehavior
deprecated

Use filters.defaultBehavior instead.

Return Values

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;

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

overtime

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

import { useTable } from "@refinedev/core";
const { overtime } = useTable();

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

sorter
deprecated

Use sorters instead.

setSorter
deprecated

Use setSorters instead.

tableQueryResult
deprecated

Use tableQuery instead.

FAQ

How can I handle relational data?

You can use useMany hook to fetch relational data.

localhost:3000/posts

import React from "react";
import {
  useTable,
  useMany,
  HttpError,
} from "@refinedev/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 = () => {
  const { tableQuery } = useTable<IPost, HttpError>();
  const posts = tableQuery?.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 (tableQuery?.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>
  );
};

How can I handle client side filtering?

First, you need to set filters.mode: "off"

import { useTable } from "@refinedev/core";
const { tableQuery, filters, setFilters } = useTable({
  filters: {
    mode: "off",
  },
});

Then, you can use the filters state to filter your data.

// ...

const List = () => {
  const { tableQuery, filters } = useTable();

  // ...

  const filteredData = useMemo(() => {
    if (filters.length === 0) {
      return tableQuery.data;
    }

    // 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 tableProps.dataSource.filter((item) => {
      return logicalFilters.some((filter) => {
        if (filter.operator === "eq") {
          return item[filter.field] === filter.value;
        }
      });
    });
  }, [tableQuery.data, filters]);
};

return (
  <div>
    {/* ...  */}
    <table>
      <tbody>
        {filteredData.map((item) => (
          <tr key={item.id}>{/* ...  */}</tr>
        ))}
      </tbody>
    </table>
  </div>
);

How can I handle client side sorting?

First, you need to set sorters.mode: "off"

import { useTable } from "@refinedev/core";
const { tableQuery, sorters, setSorters } = useTable({
  sorters: {
    mode: "off",
  },
});

Then, you can use the sorters state to sort your data.

// ...
import { useTable } from "@refinedev/core";
const List = () => {
  const { tableQuery, sorters } = useTable();

  // ...

  const sortedData = useMemo(() => {
    if (sorters.length === 0) {
      return tableQuery.data;
    }

    return tableQuery.data.sort((a, b) => {
      const sorter = sorters[0];

      if (sorter.order === "asc") {
        return a[sorter.field] > b[sorter.field] ? 1 : -1;
      } else {
        return a[sorter.field] < b[sorter.field] ? 1 : -1;
      }
    });
  }, [tableQuery.data, sorters]);

  return (
    <div>
      {/* ...  */}
      <table>
        <tbody>
          {sortedData.map((item) => (
            <tr key={item.id}>{/* ...  */}</tr>
          ))}
        </tbody>
      </table>
    </div>
  );
};

API Reference

Properties

Property	Type	Description	Default
resource	`string`	Resource name for API data interactions	Resource name that it reads from route
pagination	`Pagination`	Configuration for pagination
initialCurrent `initialCurrent` property is deprecated. Use `pagination.current` instead.	`number`	Initial page index	1
initialPageSize `initialPageSize` property is deprecated. Use `pagination.pageSize` instead.	`number`	Initial number of items per page	10
sorters	`{ initial?: CrudSort[]; permanent?: CrudSort[]; mode?: "off""server"undefined; }undefined`	Sort configs
initialSorter `initialSorter` property is deprecated. Use `sorters.initial` instead.	`CrudSort[]`	Initial sorter state
permanentSorter `permanentSorter` property is deprecated. Use `sorters.permanent` instead.	`CrudSort[]`	Default and unchangeable sorter state	`[]`
filters	`{ initial?: CrudFilter[]; permanent?: CrudFilter[]; defaultBehavior?: SetFilterBehaviorundefined; mode?: "off""server"undefined; }undefined`	Filter configs
initialFilter `initialFilter` property is deprecated. Use `filters.initial` instead.	`CrudFilter[]`	Initial filter state
permanentFilter `permanentFilter` property is deprecated. Use `filters.permanent` instead.	`CrudFilter[]`	Default and unchangeable filter state	`[]`
defaultSetFilterBehavior `defaultSetFilterBehavior` property is deprecated. Use `filters.defaultBehavior` instead.	`"replace" \| "merge"`	Default behavior of the `setFilters` function	`"merge"`
hasPagination `hasPagination` property is deprecated. Use `pagination.mode` instead.	`boolean`	Whether to use server side pagination or not.	`true`
syncWithLocation	`boolean`	Sortings, filters, page index and records shown per page are tracked by browser history	Value set in Refine. If a custom resource is given, it will be `false`
queryOptions	`UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>, QueryKey>`	react-query's useQuery options
meta	`MetaQuery`	Metadata query for dataProvider
metaData `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.	`MetaQuery`	Metadata query for dataProvider
dataProviderName	`string`	If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
successNotification	`falseOpenNotificationParams((data?: GetListResponse<TData>, values?: { config?: UseListConfig; ... 6 more ...; dataProviderName?: stringundefined; }undefined, resource?: stringundefined) => falseOpenNotificationParams)undefined`	Success notification configuration to be displayed when the mutation is successful.	"Successfully created `resource`" or "Successfully updated `resource`"
errorNotification	`falseOpenNotificationParams((error?: TError, values?: { config?: UseListConfig; pagination?: Paginationundefined; ... 5 more ...; dataProviderName?: stringundefined; }undefined, resource?: stringundefined) => falseOpenNotificationParams)undefined`	Error notification configuration to be displayed when the mutation fails.	"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code:statusCode)"
liveMode	`"auto" \| "manual" \| "off"`	Whether to update data automatically ("auto") or not ("manual") if a related live event is received. The "off" value is used to avoid creating a subscription.	`"off"`
onLiveEvent	`(event: LiveEvent) => void`	Callback to handle all related live events of this hook.	`undefined`
liveParams	`{ ids?: BaseKey[]; [key: string]: any; }`	Params to pass to liveProvider's subscribe method if liveMode is enabled.	`undefined`
overtimeOptions	`UseLoadingOvertimeCoreOptions`

Type Parameters

Property	Description	Type	Default
TQueryFnData	Result data returned by the query function. Extends `BaseRecord`	`BaseRecord`	`BaseRecord`
TError	Custom error object that extends `HttpError`	`HttpError`	`HttpError`
TSearchVariables	Values for search params		`{}`
TData	Result data returned by the `select` function. Extends `BaseRecord`. If not specified, the value of `TQueryFnData` will be used as the default value.	`BaseRecord`	`TQueryFnData`

Return values

Property	Description	Type
tableQuery	Result of the `react-query`'s `useQuery`	QueryObserverResult<{`` data: TData[];`` total: number; },`` TError>
current	Current page index state (returns `undefined` if pagination is disabled)	`number` \| `undefined`
pageCount	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`
sorters	Current sorting states	`CrudSorting`
setSorters	A function that accepts a new sorters state.	`(sorters: CrudSorting) => void`
~~sorter~~	Current sorting states	`CrudSorting`
~~setSorter~~	A function that accepts a new sorters state.	`(sorters: CrudSorting) => void`
filters	Current filters state	`CrudFilters`
setFilters	A function that accepts a new filter state	- `(filters: CrudFilters, behavior?: "merge" \\| "replace" = "merge") => void` - `(setter: (previousFilters: CrudFilters) => CrudFilters) => void`
createLinkForSyncWithLocation	A function create accessible links for syncWithLocation	`(params:` SyncWithLocationParams`) => string;`
overtime	Overtime loading props	`{ elapsedTime?: number }`

Usage​

Pagination​

Sorting​

Filtering​

Realtime Updates​

Properties​

resource​

dataProviderName​

pagination.current​

pagination.pageSize​

pagination.mode​

sorters.mode​

sorters.initial​

sorters.permanent​

filters.mode​

filters.initial​

filters.permanent​

filters.defaultBehavior​

syncWithLocation Globally ConfigurableThis value can be configured globally. Click to see the guide for more information.​

queryOptions​

meta​

successNotification​

errorNotification​

liveMode​

onLiveEvent​

liveParams​

overtimeOptions​

initialCurrent deprecated​

initialPageSize deprecated​

hasPagination deprecated​

initialSorter deprecated​

permanentSorter deprecated​

initialFilter deprecated​

permanentFilter deprecated​

defaultSetFilterBehavior deprecated​

Return Values​

tableQuery​

sorters​

setSorters​

filters​

setFilters​

current​

setCurrent​

pageSize​

setPageSize​

pageCount​

createLinkForSyncWithLocation​

overtime​

sorter deprecated​

setSorter deprecated​

tableQueryResult deprecated​

FAQ​

How can I handle relational data?​

How can I handle client side filtering?​

How can I handle client side sorting?​

API Reference​

Properties​

Type Parameters​

Return values​

Usage

Pagination

Sorting

Filtering

Realtime Updates

Properties

resource

dataProviderName

pagination.current

pagination.pageSize

pagination.mode

sorters.mode

sorters.initial

sorters.permanent

filters.mode

filters.initial

filters.permanent

filters.defaultBehavior

syncWithLocation
Globally Configurable
This value can be configured globally. Click to see the guide for more information.

queryOptions

meta

successNotification

errorNotification

liveMode

onLiveEvent

liveParams

overtimeOptions

initialCurrent
deprecated

initialPageSize
deprecated

hasPagination
deprecated

initialSorter
deprecated

permanentSorter
deprecated

initialFilter
deprecated

permanentFilter
deprecated

defaultSetFilterBehavior
deprecated

Return Values

tableQuery

sorters

setSorters

filters

setFilters

current

setCurrent

pageSize

setPageSize

pageCount

createLinkForSyncWithLocation

overtime

sorter
deprecated

setSorter
deprecated

tableQueryResult
deprecated

FAQ

How can I handle relational data?

How can I handle client side filtering?

How can I handle client side sorting?

API Reference

Properties

Type Parameters

Return values