useAutocomplete
useAutocomplete
hook allows you to manage Material UI's <Autocomplete>
component when records in a resource needs to be used as select options.
This hook uses the useList
hook for fetching data. Refer to useList hook for details. →
If you're looking for a complete select library, refine has out-of-the-box support for the libraries below:
- refine's
useSelect
(for Headless users) - Documentation - Example - Ant Design Select (for Ant Design users) - Documentation - Example
- Mantine Select (for Mantine users) - Documentation
Basic Usage
Here is a basic example of how to use useAutocomplete
hook.
Realtime Updates
This feature is only available if you use a Live Provider
When useAutocomplete
hook is mounted, it passes some parameters (channel
, resource
etc.) to the subscribe
method from the liveProvider
.
It is useful when you want to subscribe to the live updates.
For more information, refer to the
liveProvider
documentation →
Properties
resource
required
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.
useAutocomplete({
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
section of the<Refine/>
component documentation →
sorters
It allows to show the options in the desired order. sorters
will be passed to the getList
method from the dataProvider
as parameter via the useList
hook. It is used to send sorters
query parameters to the API.
For more information, refer to the
CrudSorting
interface documentation →
useAutocomplete({
sorters: [
{
field: "title",
order: "asc",
},
],
});
filters
filters
is used to show options by filtering them. filters
will be passed to the getList
method from the dataProvider
as parameter via the useList
hook. It is used to send filter query parameters to the API.
For more information, refer to the
CrudFilters
interface documentation →
useAutocomplete({
filters: [
{
field: "isActive",
operator: "eq",
value: true,
},
],
});
defaultValue
Allows to make options selected by default. Adds extra options to <select>
component. In some cases like there are many entries for the <select>
and pagination is required, defaultValue
may not be present in the current visible options and this can break the <select>
component. To avoid such cases, A seperate useMany
query is sent to the backend with the defaultValue
and appended to the options of <select>
, ensuring the default values exist in the current options array. Since it uses useMany
to query the necessary data, the defaultValue
can be a single value or an array of values like the following:
useAutocomplete({
defaultValue: 1, // or [1, 2]
});
For more information, refer to the
useMany
documentation →
debounce
It allows us to debounce
the onSearch
function.
useAutocomplete({
debounce: 500,
});
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.
For more information, refer to the
useQuery
documentation →
useAutocomplete({
queryOptions: {
retry: 3,
},
});
pagination
pagination
will be passed to the getList
method from the dataProvider
as parameter. It is used to send pagination query parameters to the API.
current
You can pass the current
page number to the pagination
property.
useAutocomplete({
pagination: {
current: 2,
},
});
pageSize
You can pass the pageSize
to the pagination
property.
useAutocomplete({
pagination: {
pageSize: 20,
},
});
mode
It can be "off"
, "client"
or "server"
. It is used to determine whether to use server-side pagination or not.
useAutocomplete({
pagination: {
mode: "off",
},
});
defaultValueQueryOptions
When the defaultValue
property is given, the useMany
data hook is called for the selected records. With this property, you can change the options of this query. If not given, the values given in queryOptions
will be used.
useAutocomplete({
resource: "categories",
defaultValueQueryOptions: {
onSuccess: (data) => {
console.log("triggers when on query return on success");
},
},
});
onSearch
It allows us to AutoComplete
the options
.
For more information, refer to the
CrudFilters
interface documentation →
If onSearch
is used, it will override the existing filters
.
Client-side filtering
Sometimes, you may want to filter the options on the client-side. You can do this by passing onSearch
function as undefined
. This will disable the server-side filtering and will filter the options on the client-side.
import { createFilterOptions } from "@mui/material";
const { autocompleteProps } = useAutocomplete({
resource: "categories",
});
const filterOptions = createFilterOptions({
matchFrom: "start",
stringify: (option: any) => option.title,
});
<Autocomplete
{...autocompleteProps}
getOptionLabel={(item) => item.title}
onInputChange={(event, value) => {}}
filterOptions={filterOptions}
isOptionEqualToValue={(option, value) =>
value === undefined ||
option?.id?.toString() === (value?.id ?? value)?.toString()
}
placeholder="Select a category"
renderInput={(params) => (
<TextField
{...params}
label="Category"
margin="normal"
variant="outlined"
required
/>
)}
/>;
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).
For more information, refer to the
meta
section of the General Concepts documentation →
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.
useAutocomplete({
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, headers } = await httpClient.get(`${url}`, { headers });
return {
data,
};
},
//...
};
dataProviderName
If there is more than one dataProvider
, you can specify which one to use by passing the dataProviderName
prop. It is useful when you have a different data provider for different resources.
useAutocomplete({
dataProviderName: "second-data-provider",
});
successNotification
NotificationProvider
is required for this prop to work.
After data is fetched successfully, useAutocomplete
can call open
function from NotificationProvider
to show a success notification. With this prop, you can customize the success notification.
useAutocomplete({
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, useAutocomplete
will call open
function from NotificationProvider
to show a error notification. With this prop, you can customize the error notification.
useAutocomplete({
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, please refer to the Live / Realtime documentation
useAutocomplete({
liveMode: "auto",
});
onLiveEvent
LiveProvider
is required for this prop to work.
The callback function that is executed when new events from a subscription are arrived.
useAutocomplete({
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 while 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 } = useAutocomplete({
//...
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>}
sort
sort
Use sorters
instead.
hasPagination
hasPagination
Use pagination.mode
instead.
hasPagination
will be passed to the getList
method from the dataProvider
as parameter via the useList
hook. It is used to determine whether to use server-side pagination or not. It is false
by default.
useAutocomplete({
hasPagination: true,
});
FAQ
How to ensure defaultValue
is included in the options?
In some cases we only have id
, it may be necessary to show it selected in the selection box. This hook sends the request via useMany
, gets the data and mark as seleted.
Can I create the options manually?
You can create a new options
object with queryResult
.
const { autocompleteProps, queryResult } = useAutocomplete();
const options = queryResult.data?.data.map((item) => ({
title: item.title,
value: item.id,
}));
return <Autocomplete {...autocompleteProps} options={options || []} />;
How do I use it with CRUD
components and useForm
?
The use of useAutocomplete
with useForm
is demonstrated in the code above. You can use the useAutocomplete
hook independently of the useForm
hook.
API Reference
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
Property | Description | Type |
---|---|---|
autocompleteProps | Material UI Autocomplete props | AutoCompleteReturnValues |
queryResult | Result of the query of a record | QueryObserverResult<{ data: TData }> |
defaultValueQueryResult | Result of the query of a defaultValue record | QueryObserverResult<{ data: TData }> |
defaultValueQueryOnSuccess | Default value onSuccess method | () => void |
overtime | Overtime loading props | { elapsedTime?: number } |
AutoCompleteReturnValues
Property Description Type options Array of options TData
loading Loading state boolean
onInputChange Callback fired when the input value changes (event: React.SyntheticEvent, value: string, reason: string) => void
filterOptions Determines the filtered options to be rendered on search. (options: TData, state: object) => TData
Example
npm create refine-app@latest -- --example field-material-ui-use-autocomplete
- Basic Usage
- Realtime Updates
- Properties
resource
sorters
filters
defaultValue
debounce
queryOptions
pagination
current
pageSize
mode
defaultValueQueryOptions
onSearch
- Client-side filtering
meta
dataProviderName
successNotification
errorNotification
liveMode
onLiveEvent
liveParams
overtimeOptions
sort
hasPagination
- FAQ
- How to ensure
defaultValue
is included in the options? - Can I create the options manually?
- How do I use it with
CRUD
components anduseForm
? - API Reference
- Properties
- Type Parameters
- Return values
- Example