Function useSelectAll

packages/ra-core/src/controller/list/useSelectAll.tsx:43–118

(
    params: UseSelectAllParams
)

 * );
 */
export const useSelectAll = (
    params: UseSelectAllParams
): UseSelectAllResult => {
    const { sort, filter, storeKey, disableSyncWithStore } = params;
    const resource = useResourceContext(params);
    if (!resource) {
        throw new Error(
            'useSelectAll should be used inside a ResourceContextProvider or passed a resource prop'
        );
    }
    const dataProvider = useDataProvider();
    const queryClient = useQueryClient();
    const [, { select }] = useRecordSelection({
        resource,
        storeKey,
        disableSyncWithStore,
    });
    const notify = useNotify();

    const handleSelectAll = useEvent(
        async ({
            queryOptions = {},
            limit = 250,
        }: HandleSelectAllParams = {}) => {
            const { meta, onSuccess, onError, ...otherQueryOptions } =
                queryOptions;
            try {
                const results = await queryClient.fetchQuery({
                    queryKey: [
                        resource,
                        'getList',
                        {
                            pagination: { page: 1, perPage: limit },
                            sort,
                            filter,
                            meta,
                        },
                    ],
                    queryFn: () =>
                        dataProvider.getList(resource, {
                            pagination: {
                                page: 1,
                                perPage: limit,
                            },
                            sort,
                            filter,
                            meta,
                        }),
                    ...otherQueryOptions,
                });

                const allIds = results.data?.map(({ id }) => id) || [];
                select(allIds);
                if (allIds.length === limit) {
                    notify('ra.message.select_all_limit_reached', {
                        messageArgs: { max: limit },
                        type: 'warning',
                    });