Skip to content

docs(pausableWatch): suggest to use Vue's native since 3.5 #4738

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 8, 2025
Merged

docs(pausableWatch): suggest to use Vue's native since 3.5 #4738

merged 2 commits into from
May 8, 2025

Conversation

toto6038
Copy link
Contributor

@toto6038 toto6038 commented May 5, 2025 •
edited
Loading

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

Since Vue 3.5, it supports the same functionality and API as pausableWatch. The documentation is updated therefore to recommend user to use Vue's builtin feature.
Maybe we can deprecate it as well? More opinions are welcome.

Additional context

The description of Pausable Watcher in Vue's documentation are in the form of examples, which is not a dedicated section that can be linked. So the first link goes to the section containing relevant examples.

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 5, 2025
OrbisK
OrbisK approved these changes May 6, 2025
View reviewed changes
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 6, 2025
@antfu antfu enabled auto-merge May 8, 2025 10:38
@antfu antfu added this pull request to the merge queue May 8, 2025
Merged via the queue into vueuse:main with commit 38389f1 May 8, 2025
8 checks passed
@toto6038 toto6038 mentioned this pull request May 9, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antfu antfu antfu approved these changes

@OrbisK OrbisK OrbisK approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@toto6038 @antfu @OrbisK