visibility
Check whether the page is visible or hidden, and react when the user switches tabs or minimises the window, via the Page Visibility API.
Import: @rtorcato/browser-common/visibility
๐ MDN: Page Visibility API ยท ๐ caniuse: pagevisibility
Browser supportโ
| API | Chrome | Edge | Firefox | Safari | iOS Safari | Baseline |
|---|---|---|---|---|---|---|
Document.visibilityState | โ 33+ | โ 12+ | โ 18+ | โ 7+ | โ 7+ | Widely available |
Document.visibilitychange_event | โ 62+ | โ 18+ | โ 56+ | โ 14.1+ | โ 14.5+ | Widely available |
โ
supported ยท โ partial ยท โ not supported ยท [n] see note. Generated from MDN browser-compat-data and web-features. caniuse: Document.visibilityState ยท Document.visibilitychange_event
Exampleโ
import {
isPageVisible,
onVisibilityChange,
} from '@rtorcato/browser-common/visibility'
if (isPageVisible()) startPolling()
const off = onVisibilityChange((state) => {
if (state === 'hidden') stopPolling()
else startPolling()
})
// later:
off()
Exportsโ
isVisibilityAvailable()โ feature checkgetVisibilityState()โ'visible'or'hidden', ornullwhere unsupportedisPageVisible()โtrue/false, ornullwhere unsupportedonVisibilityChange(callback)โ subscribe tovisibilitychange; the callback gets the new state; returns an unsubscribe function
See the API reference for full signatures.