useDocumentVisibility
Alias of usePageVisibility.
Import
TypeScript
import { useDocumentVisibility } from '@/hooks';API
Signature
useDocumentVisibility(default?) → boolean
When to use
Use useDocumentVisibility instead of re-implementing the same pattern in multiple components.
SSR / Next.js
Returns defaults on the server; hydrates on the client.
Live playground
Edit the example and see it run against the real @/hooks package in this app.
Live playgroundEdit · run with real
@/hooks · useDocumentVisibilityEditor
function Vis() { return <p>visible? {String(useDocumentVisibility())}</p>; }
Preview
Implementation source
Full library source for useDocumentVisibility — copy into your project when you are not installing a package yet.
hooks/browser/useDocumentVisibility.ts
import { usePageVisibility } from './usePageVisibility';
/** Alias of {@link usePageVisibility}. */
export function useDocumentVisibility(defaultVisible = true): boolean {
return usePageVisibility(defaultVisible);
}
Copy-paste example
useDocumentVisibility.example.tsx
'use client';
import { useDocumentVisibility } from '@/hooks';
export function Vis() {
return <p>visible? {String(useDocumentVisibility())}</p>;
}Production checklist
- Called only from Client Components or other custom hooks
- Type parameters filled in (e.g.
useFetch<User[]>) - Tip: Values are safe during SSR (defaults). Gate layout-dependent UI with useMounted when needed.
- Source of truth: open
hooks/browser/useDocumentVisibility.tsfor implementation details