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

react-use-ref-map

v1.0.2

Published

Multiple React ref management utility.

Downloads

39

Readme

react-use-ref-map

Install

npm

npm install react-use-ref-map

Yarn

yarn add react-use-ref-map

Rationale

Currently, it is possible to:

  • Keep a variable amount of refs inside a single useRef, without being easily informed when and which ref is added or removed.
    • For example, useClickAwayListener - we might want to ignore multiple refs whose amount changes over rerenders, but we don't need to know about their mounts/unmounts (the listener is attached to the window/document).
  • Keep a non-variable amount of refs by using the callback form of a ref (useCallback instead of useRef). Due to Rules of Hooks, useCallback may not be called a variable amount of times.
    • For example, useIntersectionObserver - we are interested in only one ref and we want to know when it mounts/mounts, so useCallback is ideal.

However, it is not possible to concisely keep a variable amount of refs and be informed of their addition or removal, while also keeping functions' identities to preserve memoization.

Take useMouseLeaveListener for an example - a hook that tells when the user leaves an area. The area might be complex, consisting of multiple root elements.

  • The amount of parents might be variable (nested popups and so on).
  • You want to be aware when any of them mounts/unmounts, so mouseleave listeners are added and removed accordingly.

Usage

Variable amount of refs:

function Component() {
  /* State may change over renders. */
  const [state, setState] = useState(["A", "B", "C", "D"]);
  const [setRef, refs] = useRefMap();

  return (
    <>
      {state.map((letter) => (
        <div key={letter} ref={setRef(letter)}>
          {letter}
        </div>
      ))}
    </>
  );
}

Variable amount of refs, listen to mounts/mounts:

function Component() {
  const [state, setState] = useState(["A", "B", "C", "D"]);

  const [addRef, refs] = useRefMap({
    onEnter: (key, element, refs) => {
      element.addEventListener("mouseleave", listener);
    },
    onLeave: (key, element, refs) => {
      element.removeEventListener("mouseleave", listener);

      if (!Object.values(refs.current).length) console.log("Refs are empty!");
    },
  });

  return (
    <>
      {state.map((letter) => (
        <div key={letter} ref={setRef(letter)}>
          {letter}
        </div>
      ))}
    </>
  );
}

Though less useful, non-variable amount of refs

function Component() {
  const [setRef, refs] = useRefMap();

  console.log(refs.current["outer"]); // HTMLDivElement

  return (
    <div ref={setRef("outer")}>
      <div ref={setRef("inner1")} />
      <div ref={setRef("inner2")} />
    </div>
  );
}