//#region src/hooks/usePageVisibility/usePageVisibility.d.ts
/**
 * Page visibility state derived from browser's DocumentVisibilityState.
 * Excludes 'prerender' as it is deprecated and not used in modern browsers.
 */
type VisibilityState = Exclude<DocumentVisibilityState, 'prerender'>;
/**
 * Page visibility information
 */
type PageVisibility = {
  /** True if page is currently visible */
  isVisible: boolean;
  /** Current visibility state: 'visible' | 'hidden' */
  visibilityState: VisibilityState;
};
/**
 * @description
 * `usePageVisibility` is a React hook that detects page visibility changes.
 * It monitors when the user switches tabs or minimizes the browser using the Page Visibility API.
 * Useful for pausing/resuming animations, videos, or background tasks.
 *
 * **SSR Behavior**: Returns `{ isVisible: true, visibilityState: 'visible' }` during server-side rendering.
 *
 * @returns {PageVisibility} Page visibility information
 * - `isVisible` - True if page is currently visible to the user
 * - `visibilityState` - Current visibility state: 'visible' | 'hidden'
 *
 * @example
 * function VideoPlayer() {
 *   const { isVisible } = usePageVisibility();
 *   const videoRef = useRef<HTMLVideoElement>(null);
 *
 *   useEffect(() => {
 *     if (!videoRef.current) return;
 *
 *     // Pause video when tab is hidden
 *     if (!isVisible) {
 *       videoRef.current.pause();
 *     }
 *   }, [isVisible]);
 *
 *   return <video ref={videoRef} src="video.mp4" />;
 * }
 *
 * @example
 * function Analytics() {
 *   const { isVisible, visibilityState } = usePageVisibility();
 *
 *   useEffect(() => {
 *     if (visibilityState === 'hidden') {
 *       // Track when user leaves the page
 *       analytics.track('page_hidden');
 *     }
 *   }, [visibilityState]);
 *
 *   return null;
 * }
 */
declare function usePageVisibility(): PageVisibility;
//#endregion
export { PageVisibility, VisibilityState, usePageVisibility };
//# sourceMappingURL=usePageVisibility.d.mts.map