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 thedataProvider
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.
Basic Usage
Here is a basic example of how to use the useList
hook.
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.
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.
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.
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.
For more information, refer to the
liveProvider
documentation→
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",
});
For more information, refer to the Live / Realtime page→
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
config
Use pagination
, sorters
, and filters
instead.
hasPagination
hasPagination
Use pagination.mode
instead.
hasPagination
will be passed to the getList
method from the dataProvider
as a parameter. It is used to determine whether to use server-side pagination or not.
useList({
hasPagination: false,
});
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
Properties
Type Parameters
Property | Desription | Type | Default |
---|---|---|---|
TQueryFnData | Result data returned by the query function. Extends BaseRecord | BaseRecord | BaseRecord |
TError | Custom error object that extends HttpError | HttpError | HttpError |
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
Description | Type |
---|---|
Result of the TanStack Query's useQuery | QueryObserverResult<{ data: TData[]; total: number; }, TError> |
overtime | { elapsedTime?: number } |
- Basic Usage
- Pagination
- Sorting
- Filtering
- Realtime Updates
- Properties
resource
dataProviderName
filters
sorters
pagination
current
pageSize
mode
queryOptions
meta
successNotification
errorNotification
liveMode
onLiveEvent
liveParams
overtimeOptions
config
hasPagination
- Return Values
- Additional Values
overtime
- API
- Properties
- Type Parameters
- Return Values