Guide
API
CHANGELOG
About
Guide

Home > @lynx-js/react > useLayoutEffect

useLayoutEffect() function

Warning: This API is now obsolete.

useLayoutEffect in the background thread cannot offer the precise timing for reading layout information and synchronously re-render, which is different from React.

useLayoutEffect is now an alias of useEffect. Use useEffect instead.

Accepts a function that contains imperative, possibly effectful code. The effects run after main thread dom update without blocking it.

Signature:

declare function useLayoutEffect(effect: EffectCallback, deps?: DependencyList): void;

Parameters

ParameterTypeDescription
effectEffectCallbackImperative function that can return a cleanup function
depsDependencyList(Optional) If present, effect will only activate if the values in the list change (using ===).

Returns:

void