import { CheckboxGroupProps } from "antd/lib/checkbox"; import { QueryObserverResult, UseQueryOptions } from "react-query"; import { CrudSorting, BaseRecord, GetListResponse, CrudFilters, SuccessErrorNotification, HttpError, MetaDataQuery, LiveModeProps } from "../../../interfaces"; export declare type useCheckboxGroupProps = { resource: string; optionLabel?: string; optionValue?: string; sort?: CrudSorting; filters?: CrudFilters; queryOptions?: UseQueryOptions, TError>; metaData?: MetaDataQuery; } & SuccessErrorNotification & LiveModeProps; export declare type UseCheckboxGroupReturnType = { checkboxGroupProps: CheckboxGroupProps; queryResult: QueryObserverResult>; }; /** * `useCheckboxGroup` hook allows you to manage an Ant Design {@link https://ant.design/components/checkbox/#components-checkbox-demo-group Checkbox.Group} component when records in a resource needs to be used as checkbox options. * * @see {@link https://refine.dev/docs/api-references/hooks/field/useCheckboxGroup} for more details. * * @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-references/interfaceReferences#baserecord `BaseRecord`} * */ export declare const useCheckboxGroup: ({ resource, sort, filters, optionLabel, optionValue, successNotification, errorNotification, queryOptions, liveMode, onLiveEvent, liveParams, metaData, }: useCheckboxGroupProps) => UseCheckboxGroupReturnType;