React useInsertionEffect Hook

The useInsertionEffect hook is designed specifically for CSS-in-JS library authors to synchronously inject global DOM nodes, like dynamic <style> tags or SVG <defs>—on the client side. By executing just before any layout effects fire, it ensures styles are inserted at the exact right moment during the rendering process.

• It avoids layout thrashing by ensuring the browser doesn't calculate layouts before the new styles are injected.
• It restricts access to React refs and prevents scheduling state updates due to its unique timing in the lifecycle.
• It is intended exclusively for library development rather than general application code.

Syntax:

useInsertionEffect(setup, dependencies?)
// Example
useInsertionEffect(() => {
 // insert dynamic styles before layout effects fire
 return () => {
 // cleanup
 };
}, []);

• The effect runs once on mount since the dependency array is empty ([ ]) .
• The callback function contains the logic where styles (or DOM nodes) would be inserted .
• The returned function is a cleanup that runs when the component unmounts.

Example 1: In the below example, we have used the userInsertionEffect hook, where a dynamic color style is applied to the text element with the class as "dynamic-element". The color of the text changes from green to red on each button click, which demonstrates the hook's task to insert and update styles before layout effects are fired.

Output:

Example 2: In the below example, we are using the React useInsertionEffect Hook to dynamically inject and update the styles for the button. The theme state and updating the button's appearance based on button clicks are done using the hook.

Output: