@garage-panda/use-await-dom-render

use-await-dom-render

Important

The package is under development and this is the Alpha version of it. Stay still, we are doing our best to finish it soon.

About

A React hook that waits for all elements in an HTML node to be rendered and visible in the Node. It works by adding a MutationObserver to the target node and listens for DOM updates. It has an internal timer which is reset after every update. The DOM is deemed loaded after there have not been updates for 150ms. If that does not suit your purpose, pass the wait time in the hook declaration as argument to override that value.

Example

Example on StackBlitz

Install

npm i @garage-panda/use-await-dom-render

Usage

import React from "react";
import { useAwaitDomRender } from "@garage-panda/use-await-dom-render";

function App() {
  const [observer, startWait] = useAwaitDomRender();

  React.useLayoutEffect(() => {
    const targetNode = document.querySelector("#container-component");

    observer.on("start", () => {
      console.log("Populating DOM started");
    });

    observer.on("dom-update", () => {
      console.log("Each DOM update comes here");
    });

    observer.on("load", () => {
      console.log("All DOM elements rendered");
    });

    /**
     * Make sure startWait is called after the attached listeners
     * and before ReactDOM.render call
     **/
    startWait(targetNode);

    ReactDOM.render(
      <>
        <SomeHeavySlowContent />
        <OtherContent />
      </>,
      targetNode
    );
  }, []);

  return <div id="container-component"></div>;
}

To change the default wait time after which the DOM is considered loaded use:

const [observer, startWait] = useAwaitDomRender(1000);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Support

If you like what you see, feel free to support us!

License

MIT