/reactuse

useDocumentVisibility

Returns the document visibility state.

Usage

import { useDocumentVisibility } from "@siberiacancode/reactuse";

const documentVisibility = useDocumentVisibility();

Example

const documentVisibility = useDocumentVisibility();
return <div>{documentVisibility === "hidden" ? "Hidden" : "Visible"}</div>;

callback:

const documentVisibility = useDocumentVisibility((state) => {
  if (state === "hidden") console.log("user left tab");
});

Type Declarations

export declare const useDocumentVisibility: (
  callback?: (state: DocumentVisibilityState) => void
) => DocumentVisibilityState;