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

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

Usage

Here is a basic example of how to use useAutocomplete hook.

localhost:3000
import { useAutocomplete } from "@refinedev/mui";
import { Autocomplete, TextField } from "@mui/material";

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

const PostCreate: React.FC = () => {
const { autocompleteProps } = useAutocomplete<ICategory>({
resource: "categories",
});

return (
<Autocomplete
{...autocompleteProps}
getOptionLabel={(item) => item.title}
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
/>
)}
/>
);
};

Realtime Updates

LiveProvider is required for this prop to work.

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.

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",
},
],
});
localhost:3000
import { useAutocomplete } from "@refinedev/mui";
import { Autocomplete, Button, TextField } from "@mui/material";

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

const PostCreate: React.FC = () => {
const [order, setOrder] = React.useState<"asc" | "desc">("asc");
const { autocompleteProps } = useAutocomplete<ICategory>({
resource: "categories",
sorters: [
{
field: "title",
order,
},
],
});

return (
<>
<Autocomplete
{...autocompleteProps}
getOptionLabel={(item) => item.title}
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
/>
)}
/>
<Button
onClick={() => setOrder(order === "asc" ? "desc" : "asc")}
variant="contained"
size="small"
>
Toggle Order
</Button>
</>
);
};

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 separate 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]
});

selectedOptionsOrder

selectedOptionsOrder allows us to sort selectedOptions on defaultValue. It can be:

  • "in-place": sort selectedOptions at the bottom. It is by default.
  • "selected-first": sort selectedOptions at the top.
useAutocomplete({
defaultValue: 1, // or [1, 2]
selectedOptionsOrder: "selected-first", // in-place | selected-first
});

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

localhost:3000
import { useAutocomplete } from "@refinedev/mui";
import { Autocomplete, TextField } from "@mui/material";

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

const PostCreate: React.FC = () => {
const { autocompleteProps } = useAutocomplete<ICategory>({
resource: "categories",
onSearch: (value) => [
{
field: "title",
operator: "contains",
value,
},
],
});

return (
<Autocomplete
{...autocompleteProps}
getOptionLabel={(item) => item.title}
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
/>
)}
/>
);
};

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
deprecated

Use sorters instead.

hasPagination
deprecated

Use pagination.mode instead.

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

localhost:3000
import { useAutocomplete } from "@refinedev/mui";
import { Autocomplete, TextField } from "@mui/material";

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

const PostCreate: React.FC = () => {
const { autocompleteProps } = useAutocomplete<ICategory>({
resource: "categories",
defaultValue: 11,
});

return (
<Autocomplete
{...autocompleteProps}
getOptionLabel={(item) => item.title}
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
/>
)}
/>
);
};

Can I create the options manually?

You can create a new options object with query.

const { autocompleteProps, query } = useAutocomplete();

const options = query.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?

localhost:3000
import { Create, useAutocomplete } from "@refinedev/mui";
import { Box, Autocomplete, TextField } from "@mui/material";
import { useForm } from "@refinedev/react-hook-form";
import { Controller } from "react-hook-form";

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

const PostCreate: React.FC = () => {
const {
saveButtonProps,
refineCore: { formLoading, query },
register,
control,
formState: { errors },
} = useForm<IPost, HttpError, IPost & { category: ICategory }>();

const { autocompleteProps } = useAutocomplete<ICategory>({
resource: "categories",
});

return (
<Create isLoading={formLoading} saveButtonProps={saveButtonProps}>
<Box component="form">
<Controller
control={control}
name="category"
rules={{ required: "This field is required" }}
render={({ field }) => (
<Autocomplete
{...autocompleteProps}
{...field}
onChange={(_, value) => {
field.onChange(value);
}}
getOptionLabel={({ title }) => title}
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"
error={!!errors.category}
helperText={errors.category?.message}
required
/>
)}
/>
)}
/>
</Box>
</Create>
);
};

The use of useAutocomplete with useForm is demonstrated in the code above. You can use the useAutocomplete hook independently of the useForm hook.

By default, Refine does the search using the useList hook and passes it to the search parameter. If you get a problem you should check your getList function in your Data Provider. If you want to change this behavior to make client-side filtering, you can examine this documentation.

API Reference

Properties

PropertyTypeDescriptionDefault
resource

string

Resource name for API data interactions

defaultValue

Adds extra options

meta

MetaQuery

Additional meta data to pass to the useMany from the data provider

sort

Use sorters instead

CrudSort[]

Allow us to sort the options

dataProviderName

string

If there is more than one dataProvider, you should use the dataProviderName that you will use.

default

successNotification

false

OpenNotificationParams

((data?: GetListResponse<TData>, values?: { config?: UseListConfig; ... 6 more ...; dataProviderName?: string

undefined; }

undefined, resource?: string

undefined) => false

OpenNotificationParams)

undefined

Success notification configuration to be displayed when the mutation is successful.

'"There was an error creating resource (status code: statusCode)" or "Error when updating resource (status code: statusCode)"'

errorNotification

false

OpenNotificationParams

((error?: TError, values?: { config?: UseListConfig; pagination?: Pagination

undefined; ... 5 more ...; dataProviderName?: string

undefined; }

undefined, resource?: string

undefined) => false

OpenNotificationParams)

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)"'

metaData

metaData is deprecated with refine@4, refine will pass meta instead, however, we still support metaData for backward compatibility.

MetaQuery

Additional meta data to pass to the useMany from the data provider

pagination

{ current? : number; pageSize?: number;}

Pagination option from useList()

undefined

filters

CrudFilter[]

Resource name for API data interactions

sorters

CrudSort[]

Allow us to sort the options

hasPagination

hasPagination is deprecated, use pagination.mode instead.

boolean

Disabling pagination option from useList()

false

queryOptions

UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>, QueryKey>

react-query useQuery options

liveMode

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

Callback to handle all related live events of this hook.

undefined

liveParams

Params to pass to liveProvider's subscribe method if liveMode is enabled.

undefined

overtimeOptions

UseLoadingOvertimeCoreOptions

onSearch

((value: string) => CrudFilter[])

If defined, this callback allows us to override all filters for every search request.

undefined

searchField

string

If provided optionLabel is a string, uses optionLabel's value.

"title"

selectedOptionsOrder

"in-place" | "selected-first"

Allow us to sort the selection options

in-place

debounce

number

The number of milliseconds to delay

300

defaultValueQueryOptions

UseQueryOptions<GetManyResponse<TQueryFnData>, TError, GetManyResponse<TQueryFnData>, QueryKey>

react-query useQuery options

fetchSize

use pagination instead

number

Amount of records to fetch in select box list.

undefined

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

PropertyDescriptionType
autocompletePropsMaterial UI Autocomplete propsAutoCompleteReturnValues
queryResult of the query of a recordQueryObserverResult<{ data: TData }>
defaultValueQueryResult of the query of a defaultValue recordQueryObserverResult<{ data: TData }>
defaultValueQueryOnSuccessDefault value onSuccess method() => void
overtimeOvertime loading props{ elapsedTime?: number }

AutoCompleteReturnValues

PropertyDescriptionType
optionsArray of optionsTData
loadingLoading stateboolean
onInputChangeCallback fired when the input value changes(event: React.SyntheticEvent, value: string, reason: string) => void
filterOptionsDetermines the filtered options to be rendered on search.(options: TData, state: object) => TData

Example

Run on your local
npm create refine-app@latest -- --example field-material-ui-use-autocomplete