Skip to content

Feat/use file dialog enhancements #4703

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

1-dilikelei
Copy link

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

Problem Solved by This PR

feat(useFileDialog): Attach the element to the DOMs body but making it "invisible and add id to the function config!

Specific Changes

  1. Invisible Handling and Mounting of the input Element: To ensure that the input element can be accessed normally when using automation testing tools like Playwright, we set CSS styles to make it invisible on the page and then mounted the element to the body node of the DOM. This approach not only ensures that the element does not affect the visual layout of the page but also allows testing tools to interact with it properly.
  2. Adding the id Configuration: A new id option has been added to the function configuration of useFileDialog. Users can use this option to assign a unique id to the created element. This improvement significantly enhances the element's accessibility in assistive tools (such as screen readers), making it more convenient for people with disabilities to use this feature.
  3. Removing the Element When the Component is Unmounted: To avoid memory leaks, the input element is removed from the DOM node when the tryOnScopeDispose scope is destroyed. This operation ensures that the relevant memory resources are released in a timely manner when the component is no longer in use.
import { useFileDialog } from '@vueuse/core';

const { files, open, reset, onCancel, onChange } = useFileDialog({
  accept: 'image/*',
  directory: false,
  id: 'my-file-dialog', // Newly added id configuration
});

onChange((files) => {
  // Handle the selected files
});

onCancel(() => {
  // Handle the cancellation operation
});

Additional context

In this PR, please pay special attention to the improvement of the functionality's accessibility brought by the addition of the id configuration, as well as the optimization of memory management through the logic of removing the element when the component is unmounted.

董梁玮 added 2 commits April 12, 2025 17:47
…t "invisible and add id to the function config
…t "invisible and add id to the function config
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Apr 12, 2025
@1-dilikelei
Copy link
Author

#4618

@OrbisK
Copy link
Collaborator

OrbisK commented Apr 13, 2025

Thank you for your PR.

I thinnk #4679 already solves this and is more flexible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants