[Doc] Update Soft Delete documentation #10986
Open
+1,916
−23
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
Comment on lines
242
to
257
| items: [ | ||
| enterpriseEntry('addSoftDeleteBasedOnResource'), | ||
| enterpriseEntry('addSoftDeleteInPlace'), | ||
| enterpriseEntry('useSoftDelete'), | ||
| enterpriseEntry('useSoftDeleteMany'), | ||
| enterpriseEntry('useGetListDeleted'), | ||
| enterpriseEntry('useGetOneDeleted'), | ||
| enterpriseEntry('useRestoreOne'), | ||
| enterpriseEntry('useRestoreMany'), | ||
| enterpriseEntry('useHardDelete'), | ||
| enterpriseEntry('useHardDeleteMany'), | ||
| enterpriseEntry('useDeletedRecordsListController'), | ||
| enterpriseEntry('DeletedRecordsListBase'), | ||
| enterpriseEntry('ShowDeletedBase'), | ||
| enterpriseEntry('DeletedRecordRepresentation'), | ||
| ], |
There was a problem hiding this comment.
In the OSS docs, the components are listed before the hooks.
Besides, we may need an introduction page to better explain the soft-delete feature in general, and introducing the dataProvider builders there, similar to what was done here: https://marmelab.com/react-admin/SoftDeleteDataProvider.html
However I realize this was not done for realtime hooks and components, so we have to take an arbitration here. @fzaninotto Should we take the extra time needed to add an introduction page? Should we also do it for realtime?
There was a problem hiding this comment.
Fixed the navigation and added intro
|
|
||
| You'll need to pass an object with all your resources as key so that `getListDeleted` knows where to look for deleted records. | ||
|
|
||
| > **Note on performances:** Avoid calling `getListDeleted` without a `resource` filter, as it uses a naive implementation combining multiple `getList` calls, which can lead to bad performances. It is recommended to use one list per resource in this case (see [`resource` property](./getListDeleted.md#resource)). |
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.