[Doc] Update Soft Delete documentation #10986
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slax57
requested changes
Oct 13, 2025
slax57
requested changes
Oct 13, 2025
| - Restore archived items individually or in bulk | ||
| - Track who deleted what and when | ||
|
|
||
| It provides drop-in replacements for DeleteButton and BulkDeleteButton. |
There was a problem hiding this comment.
erf, not really 😅 (in headless)
Comment on lines
+19
to
+23
| ```bash | ||
| npm install --save @react-admin/ra-soft-delete | ||
| # or | ||
| yarn add @react-admin/ra-soft-delete | ||
| ``` |
There was a problem hiding this comment.
Shouldn't we encourage to install ra-core-ee instead? 🤔
Comment on lines
+102
to
+110
| Once your provider has all soft-delete methods, pass it to the `<Admin>` component and you're ready to start using `ra-soft-delete`. | ||
|
|
||
| ```tsx | ||
| // in src/App.tsx | ||
| import { Admin } from 'react-admin'; | ||
| import { dataProvider } from './dataProvider'; | ||
|
|
||
| const App = () => <Admin dataProvider={dataProvider}>{/* ... */}</Admin>; | ||
| ``` |
There was a problem hiding this comment.
IMO we shouldn't be mentioning <Admin> nor 'react-admin' in this headless doc
|
|
||
| ```tsx | ||
| // in src/dataProvider.ts | ||
| import { addSoftDeleteBasedOnResource } from '@react-admin/ra-soft-delete'; |
There was a problem hiding this comment.
Please import from ra-core-ee instead (same below)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
@react-admin/ra-soft-deletehas been updated and we also extracted all headless components and hooks to@react-admin/ra-core-ee. The OSS documentation is out of date though.Solution
Update the OSS documentation, both standard and headless.
How To Test
make docker-docfor standard documentationmake doc-headlessfor headlessAdditional Checks
masterfor a bugfix or a documentation fix, ornextfor a featureAlso, please make sure to read the contributing guidelines.