ra-core/src/controller/list/useUnselect.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { useCallback } from 'react';

import { useRecordSelection } from './useRecordSelection';
import { Identifier } from '../../types';

/**
 * Hook to Unselect the rows of a datagrid
 *
 * @example
 *
 * const unselect = useUnselect('posts');
 * unselect([123, 456]);
 */
export const useUnselect = (resource?: string, storeKey?: string) => {
    const [, { unselect }] = useRecordSelection(
        resource
            ? { resource, storeKey }
            : { disableSyncWithStore: true, storeKey }
    );
    return useCallback(
        (ids: Identifier[], fromAllStoreKeys: boolean = false) => {
            unselect(ids, fromAllStoreKeys);
        },
        [unselect]
    );
};