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(nuxt): Add router addon to nuxt module #3975

Merged
merged 1 commit into from
May 27, 2024
Merged

Conversation

Coiggahou2002
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

The lack of @vueuse/router in the hard-coded package list of @vueuse/nuxt results in the missing of auto-imports and type-generation of hooks provided by @vueuse/router (such as useRouteHash, useRouteParams, etc.) when using @vueuse/nuxt to integrate @vueuse into Nuxt 3.

Additional context

repro: https://stackblitz.com/edit/nuxt-starter-shbyhr?file=app.vue

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label May 16, 2024
@antfu antfu merged commit 2a77ff3 into vueuse:main May 27, 2024
8 checks passed
@enkot
Copy link

enkot commented Jun 1, 2024

I think we shouldn't autoimport these composables, because Nuxt uses a custom router implementation and useRouteParams, useRouteQuery will not work correctly in Nuxt. Currently you should do this:

useRouteParams(name, defaultValue, {
  route: useRoute(),
  router: useRouter()
})

Related issues:
#2334
nuxt/nuxt#24788

cc @antfu

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

Successfully merging this pull request may close these issues.

None yet

3 participants