Skip to content

Comments

fix(useDocumentVisibility): fix type inference from string to Documen…#5248

Merged
antfu merged 1 commit intovueuse:mainfrom
webfanzc:main
Jan 14, 2026
Merged

fix(useDocumentVisibility): fix type inference from string to Documen…#5248
antfu merged 1 commit intovueuse:mainfrom
webfanzc:main

Conversation

@webfanzc
Copy link
Contributor

@webfanzc webfanzc commented Jan 13, 2026 •
edited
Loading

fix type inference from string to DocumentVisibilityState

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

Fix type inference in useDocumentVisibility by adding generic type parameter to shallowRef('visible') to ensure it returns DocumentVisibilityState instead of string.

Additional context

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jan 13, 2026
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 13, 2026
@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 14, 2026

Open in StackBlitz

@vueuse/components

npm i https://pkg.pr.new/@vueuse/components@5248

@vueuse/core

npm i https://pkg.pr.new/@vueuse/core@5248

@vueuse/electron

npm i https://pkg.pr.new/@vueuse/electron@5248

@vueuse/firebase

npm i https://pkg.pr.new/@vueuse/firebase@5248

@vueuse/integrations

npm i https://pkg.pr.new/@vueuse/integrations@5248

@vueuse/math

npm i https://pkg.pr.new/@vueuse/math@5248

@vueuse/metadata

npm i https://pkg.pr.new/@vueuse/metadata@5248

@vueuse/nuxt

npm i https://pkg.pr.new/@vueuse/nuxt@5248

@vueuse/router

npm i https://pkg.pr.new/@vueuse/router@5248

@vueuse/rxjs

npm i https://pkg.pr.new/@vueuse/rxjs@5248

@vueuse/shared

npm i https://pkg.pr.new/@vueuse/shared@5248

commit: 6a15082

@antfu antfu merged commit e8be8f8 into vueuse:main Jan 14, 2026
6 of 10 checks passed
@codecov
Copy link

codecov bot commented Jan 14, 2026

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 64.36%. Comparing base (c33eed7) to head (6a15082).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
packages/core/useDocumentVisibility/index.ts 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5248   +/-   ##
=======================================
  Coverage   64.36%   64.36%           
=======================================
  Files         343      343           
  Lines        6586     6586           
  Branches     2001     2001           
=======================================
  Hits         4239     4239           
  Misses       1946     1946           
  Partials      401      401

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

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

@webfanzc @antfu @OrbisK