Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(useDropZone): add multiple prop to control multi-file drop #4227

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

danngossinga
Copy link
Contributor

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

  • Added a multiple option to the UseDropZoneOptions interface. This controls whether multiple files can be dropped.
  • Added a preventDefaultForUnhandled option to the UseDropZoneOptions interface. This controls whether to prevent the default behavior (the browser will open files) for unhandled drop events.
  • Modified the getFiles function to respect the multiple option. If multiple is false, only the first file is kept.
  • Implemented the dropEffect management. It's set to "copy" (it will change the cursor to a "plus" sign) if the conditions are met, and "none" otherwise.
  • Created a handleDragEvent function to centralize the logic for all drag events.
  • Updated the event listeners to use the new handleDragEvent function.
  • Moved the data type checking logic into a separate checkDataTypes function for better readability.
  • We're only using DataTransfer.items for validity checking, which is accessible in all drag events. The files property of DataTransfer can only be accessed from within the drop event. See: https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/files#sect1

Additional context

- Added a multiple option to the UseDropZoneOptions interface. This controls whether multiple files can be dropped.
- Added a preventDefaultForUnhandled option to the UseDropZoneOptions interface. This controls whether to prevent the default behavior for unhandled drop events.
- Modified the getFiles function to respect the multiple option. If multiple is false, only the first file is kept.
- Implemented the dropEffect management. It's set to "copy" if the conditions are met, and "none" otherwise.
- Created a handleDragEvent function to centralize the logic for all drag events.
- Updated the event listeners to use the new handleDragEvent function.
- Moved the data type checking logic into a separate checkDataTypes function for better readability.
- We're only using DataTransfer.items for validity checking, which is accessible in all drag events. The files property of DataTransfer can only be accessed from within the drop event. See: https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/files#sect1
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Sep 15, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 16, 2024
@antfu antfu added this pull request to the merge queue Sep 16, 2024
Merged via the queue into vueuse:main with commit 3b94de4 Sep 16, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants