Skip to content

refreshWhenHidden not working properly #3039

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

Open
usuallyno opened this issue Nov 13, 2024 · 0 comments · May be fixed by #4120
Open

refreshWhenHidden not working properly #3039

usuallyno opened this issue Nov 13, 2024 · 0 comments · May be fixed by #4120

Comments

@usuallyno
Copy link

usuallyno commented Nov 13, 2024

Bug report

Description / Observed Behavior

I've encountered an issue with useSWR's refreshWhenHidden prop. Due to a known behavior across browser vendors, document.visibilityState does not update to hidden when the user changes windows or applications (e.g., using alt+tab or system gestures).

In particular, the problem lies in the isVisible function located in swr/src/_internal/utils/web-preset.ts:

const isVisible = () => {
  const visibilityState = isDocumentDefined && document.visibilityState;
  return isUndefined(visibilityState) || visibilityState !== 'hidden';
}

Since document.visibilityState stays visible during window or app switches, useSWR continues to behave as if the window is in the foreground, which interferes with refreshWhenHidden behavior.

Expected Behavior

useSWR should recognize that the window has become inactive when a user switches to another application or browser tab and should stop to revalidate data refreshWhenHidden accordingly, even if document.visibilityState remains visible.

Repro Steps / Code Example

  1. Set refreshWhenHidden to false and refreshInterval to 500 in a component using useSWR.
  2. Switch to a different window or application using alt+tab or a similar gesture.
  3. Note that document.visibilityState does not update to hidden, causing a revalidation every 5 seconds.

You can also test this behavior in a minimal CodeSandbox setup to observe the issue.

Additional Context

  • useSWR version: 2.2.5
  • Browser versions tested: Chrome 131.0.6778.70 (arm64)
  • Next.js version: 12.3.4

This issue appears to be rooted in document.visibilityState handling across browsers, but any insights on improving useSWR's behavior to account for this would be appreciated.

References

https://stackoverflow.com/questions/28993157/visibilitychange-event-is-not-triggered-when-switching-program-window-with-altt

dcondrey added a commit to dcondrey/swr that referenced this issue Apr 17, 2025
Enhanced visibility check.  Resolves vercel#3039
@dcondrey dcondrey linked a pull request Apr 17, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant