Skip to content

fix: sharedComposable #4729

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
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: sharedComposable #4729

wants to merge 1 commit into from

Conversation

lin52025iq
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

Fixed the issue where createSharedComposable cannot be properly disposed of when executed in a scope without getCurrentScope.

In the original implementation, when createSharedComposable is executed in a scope without getCurrentScope, tryOnScopeDispose directly returns false. This causes the dispose function to not be registered correctly, and thus the resources cannot be cleaned up properly. By directly calling dispose when tryOnScopeDispose returns false, we ensure that resources can be cleaned up correctly even in environments without getCurrentScope.

Before

...
tryOnScopeDispose(dispose)
...

After

...
if(!tryOnScopeDispose(dispose)) {
  dispose()
}
...

Additional context

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Apr 25, 2025
ferferga
ferferga requested changes Apr 26, 2025
View reviewed changes
Copy link
Member

@ferferga ferferga left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This composable should return cleanup instead, so users can manually stop the associated effect when desired.

Lots of composables have use cases that are valid outside effect scopes and that need reactivity outside of components.

What I said here is a breaking change, but it's one of the many inconsistencies we are fighting to remove.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ferferga ferferga ferferga requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
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.
2 participants
@lin52025iq @ferferga