52 lines
1.5 KiB
TypeScript
52 lines
1.5 KiB
TypeScript
import { useEffect, useState } from "react";
|
|
|
|
/**
|
|
* Visible viewport box, including the shrink and offset when a phone keyboard opens.
|
|
*
|
|
* iOS Safari reports the keyboard by shrinking `visualViewport.height` and
|
|
* shifting `offsetTop`. A `fixed` overlay has to use both, or its footer stays
|
|
* in the layout viewport behind the keyboard.
|
|
*
|
|
* @param enabled When false, skip listeners and return `undefined`.
|
|
* @returns Height and top offset of `visualViewport`, or `undefined` when disabled.
|
|
*
|
|
* @example
|
|
* const viewport = useVisualViewportHeight(isOpen);
|
|
*/
|
|
export function useVisualViewportHeight(
|
|
enabled: boolean,
|
|
): { height: number; offsetTop: number } | undefined {
|
|
const [frame, setFrame] = useState<
|
|
{ height: number; offsetTop: number } | undefined
|
|
>(undefined);
|
|
|
|
useEffect(() => {
|
|
if (!enabled) return;
|
|
const vp = window.visualViewport;
|
|
const sync = () => {
|
|
const next = {
|
|
height: vp?.height ?? window.innerHeight,
|
|
offsetTop: vp?.offsetTop ?? 0,
|
|
};
|
|
setFrame((prev) =>
|
|
prev &&
|
|
prev.height === next.height &&
|
|
prev.offsetTop === next.offsetTop
|
|
? prev
|
|
: next,
|
|
);
|
|
};
|
|
sync();
|
|
vp?.addEventListener("resize", sync);
|
|
vp?.addEventListener("scroll", sync);
|
|
window.addEventListener("resize", sync);
|
|
return () => {
|
|
vp?.removeEventListener("resize", sync);
|
|
vp?.removeEventListener("scroll", sync);
|
|
window.removeEventListener("resize", sync);
|
|
};
|
|
}, [enabled]);
|
|
|
|
return enabled ? frame : undefined;
|
|
}
|