useCheckboxGroup

We will demonstrate how to get data at the /tags endpoint from the https://api.fake-rest.refine.dev REST API.

{
  [
    {
      id: 1,
      title: "Driver Deposit",
    },
    {
      id: 2,
      title: "Index Compatible Synergistic",
    },
    {
      id: 3,
      title: "Plum",
    },
  ];
}

import { useCheckboxGroup } from "@refinedev/antd";
import { Form, Checkbox } from "antd";

export const PostCreate: React.FC = () => {
  const { checkboxGroupProps } = useCheckboxGroup<ITag>({
    resource: "tags",
  });

  return (
    <Form>
      <Form.Item label="Tags" name="tags">
        <Checkbox.Group {...checkboxGroupProps} />
      </Form.Item>
    </Form>
  );
};

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

All we have to do is pass the checkboxGroupProps it returns to the <Checkbox.Group> component. useCheckboxGroup uses the useList hook for fetching data.

For more information, refer to the useList documentation →

const { checkboxGroupProps } = useCheckboxGroup({
  resource: "tags",
});

resource property determines which API resource endpoint to fetch records from dataProvider. It returns properly configured options values for checkboxes.

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 →

For more information, refer to the Ant Design's Checkbox.Group component documentation →

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.

const { selectProps } = useCheckboxGroup({
  resource: "languages",
  defaultValue: [1, 2],
  selectedOptionsOrder: "selected-first", // in-place | selected-first
});

The easiest way to select default values for checkbox fields is by passing in defaultValue.

const { checkboxGroupProps } = useCheckboxGroup({
  resource: "tags",
  optionLabel: "title",
  optionValue: "id",
});

optionLabel and optionValue allows you to change the values and appearances of your options. Default values are optionLabel = "title" and optionValue = "id".

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

const { options } = useCheckboxGroup({
  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 } = useCheckboxGroup({
  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 } = useCheckboxGroup({ searchField: "name" });

onSearch("John"); // Searches 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 } = useCheckboxGroup({ optionLabel: "name" });

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

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

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

filters allows us to add filters while fetching the data. For example, if you want to list only the titles that are equal to "Driver Deposit":

const { checkboxGroupProps } = useCheckboxGroup({
  resource: "tags",
  filters: [
    {
      field: "title",
      operator: "eq",
      value: "Driver Deposit",
    },
  ],
});

sorters allows us to sort the options. For example, if you want to sort your list according to title by ascending:

const { checkboxGroupProps } = useCheckboxGroup({
  resource: "tags",
  sorters: [
    {
      field: "title",
      order: "asc",
    },
  ],
});

fetchSize is the amount of records to fetch in checkboxes.

const { selectProps } = useCheckboxGroup({
  resource: "languages",
  fetchSize: 20,
});

Passing the queryOptions property allows us to set the useQuery options

const { checkboxGroupProps } = useCheckboxGroup({
  resource: "tags",
  queryOptions: {
    onError: () => {
      console.log("triggers when on query return Error");
    },
  },
});

pagination allows us to set page and items per page values.

For example, lets say that we have 1000 post records:

const { selectProps } = useCheckboxGroup({
  resource: "categories",
  pagination: { current: 3, pageSize: 8 },
});

The listing will start from page 3, showing 8 records per page.

Use sorters instead.