npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

v0.0.9

Published

React hook that is used to await all DOM elements inside a node to be rendered

Downloads

117

Readme

npm version

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.useEffect(() => {
    const targetNode = document.querySelector("#container-component");

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

    observer.on("dom-update", () => {
      // Can be called multiple times
      console.log("Each DOM update comes here");
    });

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

    observer.on("load", () => {
      console.log("Multiple listeners can be attached, will be called in order.");
    });

    /**
     * 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" />;
}

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

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

Documentation

  • hook useAwaitDomRender(waitTime: number)

    • Returns - Array<DomObserver, StartWaitFunc>: (example: [observer, startWait]);
    • Parameters:
      • waitTime: number - how much time needs to pass with no new DOM updates, after which the load event is emitted
  • class DomObserver (first argument of return array of hook)

    • methods
      • on(event: DomObserverEvent, callback: () => void) - registers an event listener for each dom observer event. Possible events are: start , dom-update and load.
      • removeListeners() - removes all active previously attached listeners
  • type StartWaitFunc (second argument of return array of hook)

    • (targetNode: Node) => void - starts waiting for DOM updates within the provided targetNode.

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