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

fix(useRouteParams,useRouteQuery): set route param/query to undefined when function-based defaultValue #3831

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

henribru
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

This PR follows up on the changes from #3583. That PR ensured that if you set a route param/query to the default value, it was removed from the query string. However, it doesn't handle function-based default values, so if you set the param/query to the value the default function evaluates to, it remains in the query string. This PR evaluates function-based default before the comparison to avoid that.

Additional context

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Feb 29, 2024
@henribru
Copy link
Author

On second thought, maybe this isn't a good idea. When the default is a function, it could change. If you've explicitly set the query to a value, it might be unexpected for that query to change later if the value you set it to happened to be the default at that time.

@henribru
Copy link
Author

henribru commented Mar 2, 2024

On second thought, maybe this isn't a good idea. When the default is a function, it could change. If you've explicitly set the query to a value, it might be unexpected for that query to change later if the value you set it to happened to be the default at that time.

I suppose one way around this could be that when you set the query to the current default value, we still set the internal value, but keep it out of the URL params. We could then watch the default and if it changes to something else than the internal value, we could push the internal value to the URL params. But that's a lot of extra complexity just to keep the URL clean, and it might be surprising to "suddenly" see the value in the URL.

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

Successfully merging this pull request may close these issues.

None yet

1 participant