窗口焦点重新获取

如果用户离开应用后返回,且查询数据已过时,TanStack Query 会自动在后台为你请求最新数据。你可以通过 refetchOnWindowFocus 选项全局或按查询禁用此行为:

全局禁用

js
const vueQueryPluginOptions: VueQueryPluginOptions = {
  queryClientConfig: {
    defaultOptions: {
      queries: {
        refetchOnWindowFocus: false,
      },
    },
  },
}
app.use(VueQueryPlugin, vueQueryPluginOptions)
const vueQueryPluginOptions: VueQueryPluginOptions = {
  queryClientConfig: {
    defaultOptions: {
      queries: {
        refetchOnWindowFocus: false,
      },
    },
  },
}
app.use(VueQueryPlugin, vueQueryPluginOptions)

按查询禁用

tsx
useQuery({
  queryKey: ['todos'],
  queryFn: fetchTodos,
  refetchOnWindowFocus: false,
})
useQuery({
  queryKey: ['todos'],
  queryFn: fetchTodos,
  refetchOnWindowFocus: false,
})

自定义窗口聚焦事件

在极少数情况下,你可能希望自行管理触发 TanStack Query 重新验证的窗口聚焦事件。为此,TanStack Query 提供了 focusManager.setEventListener 函数,该函数会提供窗口聚焦时应触发的回调,并允许你设置自定义事件。调用 focusManager.setEventListener 时,先前设置的事件处理器会被移除(大多数情况下是默认处理器),并替换为你的新处理器。以下是默认处理器的实现示例:

tsx
focusManager.setEventListener((handleFocus) => {
  // 监听 visibilitychange 事件
  if (typeof window !== 'undefined' && window.addEventListener) {
    const visibilitychangeHandler = () => {
      handleFocus(document.visibilityState === 'visible')
    }
    window.addEventListener('visibilitychange', visibilitychangeHandler, false)
    return () => {
      // 确保在新处理器设置时取消订阅
      window.removeEventListener('visibilitychange', visibilitychangeHandler)
    }
  }
})
focusManager.setEventListener((handleFocus) => {
  // 监听 visibilitychange 事件
  if (typeof window !== 'undefined' && window.addEventListener) {
    const visibilitychangeHandler = () => {
      handleFocus(document.visibilityState === 'visible')
    }
    window.addEventListener('visibilitychange', visibilitychangeHandler, false)
    return () => {
      // 确保在新处理器设置时取消订阅
      window.removeEventListener('visibilitychange', visibilitychangeHandler)
    }
  }
})

管理聚焦状态

tsx
import { focusManager } from '@tanstack/vue-query'

// 覆盖默认聚焦状态
focusManager.setFocused(true)

// 回退到默认聚焦检查
focusManager.setFocused(undefined)
import { focusManager } from '@tanstack/vue-query'

// 覆盖默认聚焦状态
focusManager.setFocused(true)

// 回退到默认聚焦检查
focusManager.setFocused(undefined)