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(useActiveElement/useFocusWithin): replace computedWithControl with locally tracked ref #3815

Merged
merged 1 commit into from Feb 27, 2024

Conversation

jaketig
Copy link
Contributor

@jaketig jaketig commented Feb 22, 2024

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

useActiveElement and useFocusWithin are currently broken due to computedWithControl being used inside of computed triggering the following warning:

[Vue warn] Computed is still dirty after getter evaluation, likely because a computed is mutating its own dependency in its getter. State mutations in computed getters should be avoided.  Check the docs for more details: https://vuejs.org/guide/essentials/computed.html#getters-should-be-side-effect-free

This PR replaces computedWithControl with a locally tracked ref so useActiveElement can be used inside a computed as done in useFocusWithin:

const activeElement = useActiveElement(options)
const targetElement = computed(() => unrefElement(target))
const focused = computed(() => (targetElement.value && activeElement.value) ? targetElement.value.contains(activeElement.value) : false)

Additional context

related issues: #3799, #3794, #3787, #3774, #3760

upstream issue: vuejs/core#10341

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Feb 22, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 27, 2024
@antfu antfu enabled auto-merge February 27, 2024 04:26
@antfu antfu added this pull request to the merge queue Feb 27, 2024
Merged via the queue into vueuse:main with commit b142638 Feb 27, 2024
8 checks passed
webdesignberlin added a commit to FitX/customer-components that referenced this pull request Feb 29, 2024
noook pushed a commit to noook/vueuse that referenced this pull request Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants