Skip to main content
Version: 4.xx.xx
Source Code

useList

useList is an extended version of TanStack Query's useQuery that supports all of its features and also adds some more.

When you need to fetch data according to sort, filter, pagination, etc. from a resource , you can use the useList hook. It will return the data and some functions to control the query.

  • It uses the getList method as the query function from the dataProvider which is passed to <Refine>.

  • It uses a query key to cache the data. The query key is generated from the provided properties. You can see the query key by using the TanStack Query devtools.

Usage​

Here is a basic example of how to use the useList hook.

localhost:3000/products
import { useList, HttpError } from "@refinedev/core";

interface IProduct {
id: number;
name: string;
material: string;
}

const ProductList: React.FC = () => {
const { data, isLoading, isError } = useList<IProduct, HttpError>({
resource: "products",
});

const products = data?.data ?? [];

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

if (isError) {
return <div>Something went wrong!</div>;
}

return (
<ul>
{products.map((product) => (
<li key={product.id}>
<h4>
{product.name} - ({product.material})
</h4>
</li>
))}
</ul>
);
};

Pagination​

The useList hook supports the pagination feature. You can pass the pagination property to enable pagination. To handle pagination, the useList hook passes the pagination property to the getList method from the dataProvider.

Dynamically changing the pagination properties will trigger a new request.

localhost:3000/products
import { useState } from "react";
import { useList, HttpError } from "@refinedev/core";

interface IProduct {
id: number;
name: string;
material: string;
}

const ProductList: React.FC = () => {
const [current, setCurrent] = useState(1);
const [pageSize, setPageSize] = useState(5);

const { data, isLoading, isError } = useList<IProduct, HttpError>({
resource: "products",
pagination: {
current,
pageSize,
},
});

const products = data?.data ?? [];

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

if (isError) {
return <div>Something went wrong!</div>;
}

return (
<div>
<button onClick={() => setCurrent((prev) => prev - 1)}>{"<"}</button>
<span> page: {current} </span>
<button onClick={() => setCurrent((prev) => prev + 1)}>{">"}</button>
<span> per page: </span>
<select
value={pageSize}
onChange={(e) => setPageSize(Number(e.target.value))}
>
{[5, 10, 20].map((size) => (
<option key={size} value={size}>
{size}
</option>
))}
</select>

<ul>
{products.map((product) => (
<li key={product.id}>
<h4>
{product.name} - ({product.material})
</h4>
</li>
))}
</ul>
</div>
);
};

Sorting​

The useList hook supports the sorting feature,which you can enable by passing the sorters property. useList will then pass this property to the getList method from the dataProvider.

Dynamically changing the sorters property will trigger a new request.

localhost:3000/products
import { useState } from "react";
import { useList, HttpError } from "@refinedev/core";

interface IProduct {
id: number;
name: string;
material: string;
}

const ProductList: React.FC = () => {
const [order, setOrder] = useState<"asc" | "desc">("asc");

const { data, isLoading, isError } = useList<IProduct, HttpError>({
resource: "products",
sorters: [
{
field: "name",
order,
},
],
});

const products = data?.data ?? [];

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

if (isError) {
return <div>Something went wrong!</div>;
}

return (
<div>
<button
onClick={() => setOrder((prev) => (prev === "asc" ? "desc" : "asc"))}
>
toggle sort
</button>

<ul>
{products.map((product) => (
<li key={product.id}>
<h4>
{product.name} - ({product.material})
</h4>
</li>
))}
</ul>
</div>
);
};

Filtering​

The useList hook supports the filtering feature. You can pass the filters property to enable filtering. To handle filtering, the useList hook passes the filters property to the getList method from the dataProvider.

Dynamically changing the filters property will trigger a new request.

localhost:3000/products
import { useState } from "react";
import { useList, HttpError } from "@refinedev/core";

interface IProduct {
id: number;
name: string;
material: string;
}

const ProductList: React.FC = () => {
const [value, setValue] = useState("Cotton");

const { data, isLoading, isError } = useList<IProduct, HttpError>({
resource: "products",
filters: [
{
field: "material",
operator: "eq",
value,
},
],
});

const products = data?.data ?? [];

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

if (isError) {
return <div>Something went wrong!</div>;
}

return (
<div>
<span> material: </span>
<select value={value} onChange={(e) => setValue(e.target.value)}>
{["Cotton", "Bronze", "Plastic"].map((material) => (
<option key={material} value={material}>
{material}
</option>
))}
</select>

<ul>
{products.map((product) => (
<li key={product.id}>
<h4>
{product.name} - ({product.material})
</h4>
</li>
))}
</ul>
</div>
);
};

Realtime Updates​

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

When the useList 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
required
​

This parameter will be passed to the getList method from the dataProvider as a parameter. It is usually used as an API endpoint path but it all depends on how you handle the resource in the getList method.

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

For more information, refer to the creating a data provider tutorial β†’

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​

This prop allows you to specify which dataProvider if you have more than one. Just pass it like in the example:

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

filters​

filters will be passed to the getList method from the dataProvider as a parameter. It is used to send filter query parameters to the API.

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

For more information, refer to the CrudFilters interface β†’

sorters​

sorters will be passed to the getList method from the dataProvider as a parameter. It is used to send sort query parameters to the API.

useList({
sorters: [
{
field: "title",
order: "asc",
},
],
});

For more information, refer to the CrudSorting interface β†’

pagination​

pagination will be passed to the getList method from the dataProvider as a parameter. It is used to send pagination query parameters to the API.

current​

You can pass the current page number to the pagination property.

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

pageSize​

You can pass the pageSize to the pagination property.

useList({
pagination: {
pageSize: 20,
},
});

mode​

This property can be "off", "client" or "server". It is used to determine whether to use server-side pagination or not.

useList({
pagination: {
mode: "off",
},
});

queryOptions​

queryOptions is used to pass additional options to the useQuery hook. It is useful when you want to pass additional options to the useQuery hook.

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

For more information, refer to the useQuery documentation→

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

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.

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

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

//...
//...

const { data } = await httpClient.get(`${url}`, { headers });

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

For more information, refer to the meta section of the General Concepts documentation→

successNotification​

NotificationProvider is required for this prop to work.

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

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

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

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

onLiveEvent​

LiveProvider is required for this prop to work.

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

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

const { overtime } = useList({
//...
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>;
}

config
deprecated
​

Use pagination, sorters, and filters instead.

hasPagination
deprecated
​

Use pagination.mode instead.

Return Values​

Returns an object with TanStack Query's useQuery return values.

For more information, refer to the useQuery documentation→

Additional Values​

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 } = useList();

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

API Reference​

Properties​

Type Parameters​

PropertyDescriptionTypeDefault
TQueryFnDataResult data returned by the query function. Extends BaseRecordBaseRecordBaseRecord
TErrorCustom error object that extends HttpErrorHttpErrorHttpError
TDataResult data returned by the select function. Extends BaseRecord. If not specified, the value of TQueryFnData will be used as the default value.BaseRecordTQueryFnData

Return Values​

DescriptionType
Result of the TanStack Query's useQueryQueryObserverResult<{ data: TData[]; total: number; }, TError>
overtime{ elapsedTime?: number }