import { QueryObserverResult, UseQueryOptions } from "react-query"; import { ListProps } from "antd/lib/list"; import { FormProps } from "antd/lib/form"; import { BaseRecord, CrudFilters, CrudSorting, GetListResponse, SuccessErrorNotification, HttpError, MetaDataQuery, LiveModeProps } from "../../../interfaces"; export declare type useSimpleListProps = ListProps & { syncWithLocation?: boolean; resource?: string; initialFilter?: CrudFilters; permanentFilter?: CrudFilters; initialSorter?: CrudSorting; permanentSorter?: CrudSorting; onSearch?: (data: TSearchVariables) => CrudFilters | Promise; queryOptions?: UseQueryOptions, TError>; metaData?: MetaDataQuery; } & SuccessErrorNotification & LiveModeProps; export declare type useSimpleListReturnType = { listProps: ListProps; queryResult: QueryObserverResult, TError>; searchFormProps: FormProps; filters: CrudFilters; }; /** * By using `useSimpleList` you get props for your records from API in accordance with Ant Design {@link https://ant.design/components/list/ ``} component. * All features such as pagination, sorting come out of the box. * * @see {@link https://refine.dev/docs/api-references/hooks/show/useSimpleList} for more details. * * @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-references/interfaceReferences#baserecord `BaseRecord`} * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-references/interfaceReferences#httperror `HttpError`} * @typeParam TSearchVariables - Antd form values * */ export declare const useSimpleList: ({ resource: resourceFromProp, initialSorter, initialFilter, permanentFilter, permanentSorter, onSearch, queryOptions, syncWithLocation: syncWithLocationProp, successNotification, errorNotification, liveMode, onLiveEvent, liveParams, metaData, ...listProps }?: useSimpleListProps) => useSimpleListReturnType;