Back to React Admin

addSoftDeleteBasedOnResource

docs_headless/src/content/docs/addSoftDeleteBasedOnResource.md

5.14.6718 B
Original Source

This helper function wraps an existing dataProvider to add the soft delete capabilities, storing all deleted records in a single deleted_records (configurable) resource.

This feature requires a valid Enterprise Edition subscription.

Installation

bash
npm install --save @react-admin/ra-core-ee
# or
yarn add @react-admin/ra-core-ee

Usage

tsx
// in src/dataProvider.ts
import { addSoftDeleteBasedOnResource } from '@react-admin/ra-core-ee';
import baseDataProvider from './baseDataProvider';

export const dataProvider = addSoftDeleteBasedOnResource(
    baseDataProvider,
    { deletedRecordsResourceName: 'deleted_records' }
);