Skip to main content

@rtorcato/browser-common / visibility

visibility

Functions​

isVisibilityAvailable()​

isVisibilityAvailable(): boolean

Defined in: visibility/index.ts:10

Checks if the Page Visibility API is available in the current environment.

Example​

import { isVisibilityAvailable } from '@rtorcato/browser-common/visibility'
if (isVisibilityAvailable()) pauseWhenHidden()

Returns​

boolean

True if document.visibilityState exists, false otherwise.


getVisibilityState()​

getVisibilityState(): DocumentVisibilityState | null

Defined in: visibility/index.ts:23

Gets the page's current visibility state, or null if unsupported.

Example​

import { getVisibilityState } from '@rtorcato/browser-common/visibility'
console.log(getVisibilityState()) // 'visible'

Returns​

DocumentVisibilityState | null

'visible' or 'hidden', or null where the Page Visibility API is unavailable.


isPageVisible()​

isPageVisible(): boolean | null

Defined in: visibility/index.ts:36

Checks whether the page is currently visible.

Example​

import { isPageVisible } from '@rtorcato/browser-common/visibility'
if (isPageVisible()) refreshData()

Returns​

boolean | null

True if visible, false if hidden, or null where the Page Visibility API is unavailable.


onVisibilityChange()​

onVisibilityChange(callback): () => void

Defined in: visibility/index.ts:52

Listens for page visibility changes.

Example​

import { onVisibilityChange } from '@rtorcato/browser-common/visibility'
const off = onVisibilityChange((state) => (state === 'hidden' ? pause() : resume()))
off()

Parameters​

callback​

(state) => void

Called with the new visibility state on each visibilitychange event.

Returns​

A function that removes the listener (a no-op where unsupported).

() => void