R
fn

useDocumentVisibility

v0.0.15testeddemo

Reactive `document.visibilityState`.

Examples

ts
const visibility = useDocumentVisibility();
watch(visibility, (state) => {
  if (state === 'visible') refresh();
});
ts
useDocumentVisibility({
  onChange: (state) => {
    if (state === 'hidden') pausePlayback();
  },
});

Demo

Loading demo…

Signature

ts
export function useDocumentVisibility(
  options: UseDocumentVisibilityOptions ={ ... }

Parameters

ParameterTypeDescription
options?UseDocumentVisibilityOptionsOptions (custom `document`, `onChange` callback)

Returns

UseDocumentVisibilityReturnThe current visibility state