For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/react/Function.useLayoutEffect.md.
ReactLynx logo
ReactLynx
  • English

      • @lynx-js/react / useLayoutEffect

      Function: useLayoutEffect() 

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

      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.

      Parameters

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

      Returns

      void

      Deprecated

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

      Defined in

      @lynx-js/react/runtime/lib/core/hooks/react.d.ts:26

      Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.