Open History to see the last commit
1---
2id: FocusManager
3title: FocusManager
4---
5β
6The `FocusManager` manages the focus state within React Query.
7β
8It can be used to change the default event listeners or to manually change the focus state.
9β
10Its available methods are:
11β
12- [`setEventListener`](#focusmanagerseteventlistener)
13- [`setFocused`](#focusmanagersetfocused)
14- [`isFocused`](#focusmanagerisfocused)
15β
16## `focusManager.setEventListener`
17β
18`setEventListener` can be used to set a custom event listener:
19β
20```js
21import { focusManager } from 'react-query'
22β
23focusManager.setEventListener(handleFocus => {
24 // Listen to visibilitychange and focus
25 if (typeof window !== 'undefined' && window.addEventListener) {
26 window.addEventListener('visibilitychange', handleFocus, false)
27 window.addEventListener('focus', handleFocus, false)
28 }
29β
30 return () => {
31 // Be sure to unsubscribe if a new handler is set
32 window.removeEventListener('visibilitychange', handleFocus)
33 window.removeEventListener('focus', handleFocus)
34 }
35})
36```
37β
38## `focusManager.setFocused`
39β
40`setFocused` can be used to manually set the focus state. Set `undefined` to fallback to the default focus check.
41β
42```js
43import { focusManager } from 'react-query'
44β
45// Set focused
46focusManager.setFocused(true)
47β
48// Set unfocused
49focusManager.setFocused(false)
50β
51// Fallback to the default focus check
52focusManager.setFocused(undefined)
53```
54β
55**Options**
56β
57- `focused: boolean | undefined`
58β
59## `focusManager.isFocused`
60β
61`isFocused` can be used to get the current focus state.
62β
63```js
64const isFocused = focusManager.isFocused()
65```