Use cases for `useInsertionEffect` React hook

Intro

Everybody familiar with useEffect hook, sometimes useLayoutEffect is more appropriate.

Not so many people ever used useInsertionEffect, let's explore it.

API for hook is very similar to useEffect, need to add code into setup function, dependencies array and it can return a cleanup function.

React docs give this description.

useInsertionEffect is for CSS-in-JS library authors.

It can be useful for other purposes, mainly to run some code once on component mount, e.g. add event listener to a window.

Use cases

Shiki code highlighter

  React.useInsertionEffect(() => {
    initShiki().then((highlight) => {
      setHtml(highlight(content));
    });
  }, [content]);

Event listeners for window

  useInsertionEffect(() => {
    const popCb = () => {
      const newVal = parse(filterUnknownParamsClient(defaultState));
      state.current = newVal
    };

    window.addEventListener(popstateEv, popCb);

    return () => {
      window.removeEventListener(popstateEv, popCb);
    };
  }, []);

Some custom subscriptions

  useInsertionEffect(() => {
    const cb = () => {
      _setState(stateMap.get(stateShape.current) || stateShape.current);
    };
    const unsub = subscribers.add(stateShape.current, cb);

    return () => {
      unsub();
    };
  }, []);

Pros and cons

• The main benefit of this hook is to run code before component rendered, and before other hooks.
• You're not supposed to use useState.setState from inside this hook, but it is work, maybe it will change in the future.
• Refs aren't attached by the time hook run.