Fix<DeleteButton mutationOptions> ignores meta parameter
#8023
Conversation
This file contains 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
[skip ci]
fzaninotto
requested changes
Jul 30, 2022
packages/ra-core/src/controller/button/useDeleteWithConfirmController.tsx
Outdated
Show resolved
Hide resolved
packages/ra-core/src/controller/button/useDeleteWithUndoController.tsx
Outdated
Show resolved
Hide resolved
packages/ra-ui-materialui/src/button/BulkDeleteWithConfirmButton.tsx
Outdated
Show resolved
Hide resolved
packages/ra-ui-materialui/src/button/BulkDeleteWithUndoButton.tsx
Outdated
Show resolved
Hide resolved
| | --------------------| -------- | --------------- | ------------------ | ---------------------------------------------------| | ||
| | `label` | Optional | `string` | 'ra.action.delete' | label or translation message to use | | ||
| | `icon` | Optional | `ReactElement` | `<DeleteIcon>` | iconElement, e.g. `<CommentIcon />` | | ||
| | `mutationOptions` | Optional | `object` | null | options for react-query `useMutation` hook | |
There was a problem hiding this comment.
The description isn't entirely accurate, as react-query's options cannot contain a meta key. In fact, you should probably add an example explaining how to set the meta parameter.
There was a problem hiding this comment.
There is a meta option in useMutation. It is of type Record<string, unknown> when ours is any though.
| @@ -277,6 +277,7 @@ Delete the current record after a confirm dialog has been accepted. To be used i | |||
| | `confirmContent` | Optional | `ReactNode` | 'ra.message.delete_content' | Message or React component to be used as the body of the confirm dialog | | |||
| | `redirect` | Optional | `string | false | Function` | 'list' | Custom redirection after success side effect | | |||
| | `translateOptions` | Optional | `{ id?: string, name?: string }` | {} | Custom id and name to be used in the confirm dialog's title | | |||
| | `mutationOptions` | Optional | | null | options for react-query `useMutation` hook | | |||
|
Could you add a test to prove that it works? |
Here you are, colleague of little faith. |
fzaninotto
requested changes
Aug 4, 2022
packages/ra-core/src/controller/button/useDeleteWithConfirmController.spec.tsx
Outdated
Show resolved
Hide resolved
packages/ra-core/src/controller/button/useDeleteWithUndoController.spec.tsx
Outdated
Show resolved
Hide resolved
packages/ra-core/src/controller/button/useDeleteWithConfirmController.spec.tsx
Outdated
Show resolved
Hide resolved
packages/ra-core/src/controller/button/useDeleteWithConfirmController.spec.tsx
Show resolved
Hide resolved
packages/ra-core/src/controller/button/useDeleteWithUndoController.spec.tsx
Outdated
Show resolved
Hide resolved
fzaninotto
approved these changes
Aug 4, 2022
fzaninotto
changed the title
meta<DeleteButton mutationOptions> cannot include a meta parameter
fzaninotto
changed the title
<DeleteButton mutationOptions> cannot include a meta parameter<DeleteButton mutationOptions> ignores meta parameter
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix #8016
Kudos to @carlos-duran
mutationOptionson<BulkDeleteWithConfirmButton>and<BulkDeleteWithUndoButton>generates an errormutationOptionsprop description on delete buttons documentationuseMutation documentation.