Skip to content

fix(useRouteParams): solve the problem of the default value remaining in the URL #4737

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 6 commits into
base: main
Choose a base branch
from

Conversation

1-dilikelei
Copy link

@1-dilikelei 1-dilikelei commented May 5, 2025

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 fixes #4732
The problem that occurred:

  • There is a default value, but it is not retained in the URL.

  • The judgment on whether to use the default value can only be made when assigning a value to the ref reference, which triggers the set function (and the judgment logic is incorrect).

solution:

  • Perform logical judgment outside the scope of the set function. If there is a default value, add it to the param and _paramsQueue.

  • Inside the scope of the set function, if a manual assignment is made, replace the default value.

  • Move the code logic for updating the current params parameter, which is currently placed in the nextTick function, outside the set function. This way, it can break free from the constraint that the params of the current route can only be updated when a value is assigned to the ref reference.

test:
It has been thoroughly tested. When there is a default value and no manual assignment is made, the default value can be added to the params parameter in the route.

Additional context

Please review whether my Pull Request (PR) is correct. If it is correct, I will continue to expand it to useRouteQuery.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label May 5, 2025
@OrbisK OrbisK changed the title fix(useRouteParams):solve the problem of the default value remaining in the URL.(#4732) fix(useRouteParams): solve the problem of the default value remaining in the URL.(#4732) May 6, 2025
@OrbisK OrbisK changed the title fix(useRouteParams): solve the problem of the default value remaining in the URL.(#4732) fix(useRouteParams): solve the problem of the default value remaining in the URL May 6, 2025
Comment on lines 40 to 44
/**
* Set the id attribute for the input element (for accessibility and testing purposes).
*/
id?: string
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should wait for this: #4679

Comment on lines 6 to 23
// const userName=useRouteQuery('userName','Mike')
// userName.value='Mike'
const userId=useRouteParams('userId',123)
userId.value=1
userId.value=999
const route=useRoute()
const handleClick=()=>{
console.log(userId.value);
console.log(route.fullPath);
console.log(route.path);
console.log(route.params);

// console.log(userName.value);
// console.log(route.fullPath);
// console.log(route.path);
// console.log(route.params);
// console.log(route.query);
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove the playground changes 😅

../../README.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this causes linting to crash

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, there might be some issues with the version of the code I submitted. I will adjust it immediately.

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels May 6, 2025
@1-dilikelei 1-dilikelei closed this May 6, 2025
@1-dilikelei 1-dilikelei reopened this May 6, 2025
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.

useRouteQuery/useRouteParam | Add an option to keep the information in URL for the default value
2 participants