Skip to main content

Variable: useIsomorphicLayoutEffect

const useIsomorphicLayoutEffect: typeof useLayoutEffect

Defined in: use-isomorphic-layout-effect.ts:42

A drop-in replacement for useLayoutEffect that is safe to use in server-rendered apps.

In the browser it is useLayoutEffect: the effect runs synchronously after React updates the DOM and before the browser paints, so you can measure or adjust the layout without a visible flicker. Where there is no DOM (server rendering, React Native) it falls back to useEffect. Neither runs during server rendering, but useLayoutEffect triggers a warning there in React 18, which this avoids.

It has exactly the same signature and semantics as useLayoutEffect, so it can be swapped in anywhere, including inside your own hooks. The choice is made once, when the module loads.

To have react-hooks/exhaustive-deps check its dependencies, add it to the rule's additionalHooks option.

Param​

effect

The effect to run. May return a cleanup function.

Param​

deps

Dependencies that control when the effect re-runs, as with useLayoutEffect.

Example​

const ref = useRef<HTMLTextAreaElement>(null);

useIsomorphicLayoutEffect(() => {
const el = ref.current;
if (!el) return;
el.style.height = "auto";
el.style.height = `${el.scrollHeight}px`;
}, [value]);