[New Feature] Add validateFileRemoval prop to FileInput for handling remove files with confirming #7003
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
tkow
force-pushed
the
feat/6998_on_remove_with_confirm
branch
from
9311360 to
4587a5a
Compare
…_on_remove_with_confirm
tkow
changed the title
WiXSL
approved these changes
Jan 10, 2022
|
Looks pretty good! |
fzaninotto
requested changes
Jan 10, 2022
| @@ -247,6 +251,208 @@ describe('<FileInput />', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| describe('should stop to remove file field onSubmitReview return false', () => { | |||
There was a problem hiding this comment.
Suggested change
| describe('should stop to remove file field onSubmitReview return false', () => { | |
| describe('should call onSubmitReview on removal to allow developers to conditionally prevent the removal', () => { |
| @@ -33,6 +33,7 @@ export const FileInput = ( | |||
| maxSize, | |||
| minSize, | |||
| multiple = false, | |||
| onSubmitRemove, | |||
There was a problem hiding this comment.
I'd call it validateFileRemoval, and make it return either an empty promise (validated) or a rejected promise (failed).
docs/Inputs.md
Outdated
| @@ -278,6 +278,7 @@ To override the style of all instances of `<ImageInput>` using the [material-ui | |||
| | `labelSingle` | Optional | `string` | 'ra.input.file. upload_single' | Invite displayed in the drop zone if the input accepts one file | | |||
| | `labelMultiple` | Optional | `string` | 'ra.input.file. upload_several' | Invite displayed in the drop zone if the input accepts several files | | |||
| | `placeholder` | Optional | `ReactNode` | - | Invite displayed in the drop zone, overrides `labelSingle` and `labelMultiple` | | |||
| | `onSubmitRemove` | Optional | `Function` | - | Set remove button click handler. Main difference from options.onRemove is able to cancel to remove the file's list item if it returns false `(file) => boolean \| Promise<boolean>` | | |||
There was a problem hiding this comment.
I find the bevaiour that you describe a bit odd. If, ofr any reason, the onSubmitRemove returns false, then nothing happens... It's confusing for the end user.
Shouldn't the component show an error notification in that case?
docs/Inputs.md
Outdated
| @@ -278,6 +278,7 @@ To override the style of all instances of `<ImageInput>` using the [material-ui | |||
| | `labelSingle` | Optional | `string` | 'ra.input.file. upload_single' | Invite displayed in the drop zone if the input accepts one file | | |||
| | `labelMultiple` | Optional | `string` | 'ra.input.file. upload_several' | Invite displayed in the drop zone if the input accepts several files | | |||
| | `placeholder` | Optional | `ReactNode` | - | Invite displayed in the drop zone, overrides `labelSingle` and `labelMultiple` | | |||
| | `onSubmitRemove` | Optional | `Function` | - | Set remove button click handler. Main difference from options.onRemove is able to cancel to remove the file's list item if it returns false `(file) => boolean \| Promise<boolean>` | | |||
| | `options` | Optional | `Object` | `{}` | Additional options passed to react-dropzone's `useDropzone()` hook. See [the react-dropzone source](https://github.com/react-dropzone/react-dropzone/blob/master/src/index.js) for details . | | |||
|
|
|||
| `<FileInput>` also accepts the [common input props](./Inputs.md#common-input-props). | |||
There was a problem hiding this comment.
You probably need to give an example usage for the new prop (kind of what you added to the GitHub issue)
| }); | ||
| it('error occurs', async done => { | ||
| const onSubmit = jest.fn(); | ||
| // NOTE: We couldn't handle UnhandledPromiseRejection and make |
There was a problem hiding this comment.
this should be fixed by the approach I suggest
There was a problem hiding this comment.
This test is no longer needed thanks to your suggestion. It is enough only to test when throwing exception and it is now already implemented.
…_on_remove_with_confirm
Co-authored-by: Francois Zaninotto <fzaninotto@gmail.com>
…kow/react-admin into feat/6998_on_remove_with_confirm
…n cancel removal action using promise
tkow
force-pushed
the
feat/6998_on_remove_with_confirm
branch
from
c9a38a7 to
4399a1d
Compare
tkow
force-pushed
the
feat/6998_on_remove_with_confirm
branch
from
4399a1d to
f0fc51c
Compare
tkow
force-pushed
the
feat/6998_on_remove_with_confirm
branch
from
f0fc51c to
b1df2c8
Compare
|
@fzaninotto |
…_on_remove_with_confirm
|
@fzaninotto |
fzaninotto
approved these changes
Jan 18, 2022
|
Thanks! |
WiXSL
changed the title
This was referenced Jan 28, 2022
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.
closes #6998
Add onSubmitRemove prop to FileInput for handling remove files with confirming.
We can add confirm process with immediately removing files cases.
See the detail in #6998.