useSelect

Here is a basic example that uses the useSelect hook.

import { useSelect } from "@refinedev/antd";
import { Select } from "antd";

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

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

  return (
    <Select
      placeholder="Select a category"
      style={{ width: 300 }}
      {...selectProps}
    />
  );
};

LiveProvider is required for this prop to work.

When the useSelect hook is mounted, it passes some parameters (channel, resource etc.) to the subscribe method from the liveProvider that allow you to subscribe to live updates.

resource 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 but it all depends on how you handle the resource in the getList method.

See the creating a data provider documentation for an example of how resource are handled.

useSelect({
  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 →

Allows you to change the value and label of your options. Default values are optionLabel = "title" and optionValue = "id"

useSelect<ICategory>({
    resource: "products",
    optionLabel: "name"
    optionValue: "productId"
});

These properties also support nested property access with Object path syntax.

const { options } = useSelect({
  resource: "categories",
  optionLabel: "nested.title",
  optionValue: "nested.id",
});

It's also possible to pass function to these props. These functions will receive item argument.

const { options } = useSelect({
  optionLabel: (item) => `${item.firstName} ${item.lastName}`,
  optionValue: (item) => item.id,
});

Can be used to specify which field will be searched with value given to onSearch function.

const { onSearch } = useSelect({ searchField: "name" });

onSearch("John"); // Searchs by `name` field with value John.

By default, it uses optionLabel's value, if optionLabel is a string. Uses title field otherwise.

// When `optionLabel` is string.
const { onSearch } = useSelect({ optionLabel: "name" });

onSearch("John"); // Searchs by `name` field with value John.

// When `optionLabel` is function.
const { onSearch } = useSelect({
  optionLabel: (item) => `${item.id} - ${item.name}`,
});

onSearch("John"); // Searchs by `title` field with value John.

sorters prop allows you to show the options in the desired order. It will be passed to the getList method from the dataProvider as parameter via the useList hook and used to send sort query parameters to the API.

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

import { useSelect } from "@refinedev/antd";
import { Select, Button } from "antd";

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

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

  const { selectProps } = useSelect<ICategory>({
    resource: "categories",
    sorters: [
      {
        field: "title",
        order,
      },
    ],
  });

  return (
    <>
      <Select
        placeholder={`Ordered Categories: ${order}`}
        style={{ width: 300 }}
        {...selectProps}
      />
      <Button onClick={() => setOrder(order === "asc" ? "desc" : "asc")}>
        Toggle Order
      </Button>
    </>
  );
};

For more information, refer to the CrudSorting interface documentation →

filters is used to filter the options you are showing. filters will be passed to the getList method from the dataProvider as parameter via the useList hook and used to send filter query parameters to the API.

useSelect({
  filters: [
    {
      field: "isActive",
      operator: "eq",
      value: true,
    },
  ],
});

For more information, refer to the CrudFilters interface documentation →

The defaultValue is a property that can be used to not only set default options for a <select> component but also add extra options.

However, issues may arise when the <select> component has many entries and pagination is required. In such cases, the defaultValue might not be visible among the currently displayed options, which could cause the <select> component to malfunction.

To prevent this, a separate useMany query is sent to the backend carrying the defaultValue and added to the options of the <select> component, ensuring that the default values are always present in the current array of options.

Since the useMany query is used to query the necessary data, the defaultValue can be a single value or an array of values like the following:

useSelect({
  defaultValue: 1, // or [1, 2]
});

For more information, refer to the useMany documentation →

This prop allows us to debounce the onSearch function.

useSelect({
  resource: "categories",
  debounce: 500,
});

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.

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

For more information, refer to the useQuery documentation →

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

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

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

You can pass the pageSize to the pagination property.

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

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

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

When the defaultValue property is given, the useMany data hook is called for the selected records. defaultValueQueryOptions allows you to change the options of this query.

If defaultValue property is not given, the values given in the queryOptions will be used instead.

const { options } = useSelect({
  resource: "categories",
  defaultValueQueryOptions: {
    onSuccess: (data) => {
      console.log("triggers when on query return on success");
    },
  },
});

onSearch allows the addittion of AutoComplete to the options.

import { useSelect } from "@refinedev/antd";
import { Select } from "antd";

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

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

  return (
    <Select
      placeholder="Select a category"
      style={{ width: 300 }}
      {...selectProps}
    />
  );
};

If onSearch is used, it will override the existing filters.

For more information, refer to the CrudFilters interface documentation →

Sometimes, you may want to filter the options on the client-side. You can do this by passing the onSearch function as undefined and setting filterOption to true. You can also set optionFilterProp to label or value to filter the options by label or value respectively.

const { selectProps } = useSelect({
  resource: "categories",
});

<Select
  {...selectProps}
  onSearch={undefined}
  filterOption={true}
  optionFilterProp="label" // or "value"
/>;

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.

useSelect({
  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,
    };
  },
  //...
};

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

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 different data providers for different resources.

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

NotificationProvider is required for this prop to work.

After data is fetched successfully, useSelect can call the open function from NotificationProvider to show a success notification. This prop allows you to customize the success notification message

useSelect({
  successNotification: (data, values, resource) => {
    return {
      message: `${data.title} Successfully fetched.`,
      description: "Success with no errors",
      type: "success",
    };
  },
});

NotificationProvider is required for this prop to work.

After data fetching is failed, useSelect will call the open function from NotificationProvider to show an error notification. This prop allows you to customize the error notification message

useSelect({
  errorNotification: (data, values, resource) => {
    return {
      message: `Something went wrong when getting ${data.id}`,
      description: "Error",
      type: "error",
    };
  },
});

LiveProvider is required for this prop to work.

This property 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.

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

For more information, refer to the Live / Realtime documentation →

LiveProvider is required for this prop to work.

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

useSelect({
  onLiveEvent: (event) => {
    console.log(event);
  },
});

LiveProvider is required for this prop to work.

Params to pass to liveProvider's subscribe method.

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 } = useSelect({
  //...
  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>;
}

Use sorters instead.

Use pagination.mode instead.

onSearch is a function that is used to set the search value. It is useful when you want to search for a specific value. A simple example of this is shown below.

import { useSelect } from "@refinedev/antd";
import { Select } from "antd";

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

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

  return (
    <Select
      placeholder="Select a category"
      style={{ width: 300 }}
      {...selectProps}
    />
  );
};

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.

import { useSelect } from "@refinedev/antd";
import { Select } from "antd";

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

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

  return (
    <Select
      placeholder="Select a category"
      style={{ width: 300 }}
      {...selectProps}
    />
  );
};

optionLabel and optionValue are used to change the value of your options. The default values are optionsLabel="title" and optionsValue="id".

To change to name and categoryId;

useSelect({
  optionLabel: "name",
  optionValue: "categoryId",
});

Sometimes it may not be enough to create optionLabel and optionValue options. In this case we create options with queryResult.

const { queryResult } = useSelect();

const options = queryResult.data?.data.map((item) => ({
  label: item.title,
  value: item.id,
}));

return <Select options={options} />;