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

use-ref-list

v1.0.2

Published

Easily manage an ordered list of refs in React.

Downloads

8

Readme

🤹 use-ref-list

Easily manage an ordered list of refs in React.

Codesandbox Demo

Why not useRef?

This library aims to solve the problem of obtaining a list of refs where the order matters like when interacting with lists for keyboard controls. It does so by utilizing useMutableSource to collect refs in the order they appear in the rendered tree no matter if they are memoized or deep within the tree.

Install

yarn add use-ref-list
npm install use-ref-list

Usage

Due to the use of useMutableSource internally, this package only works with the experiemental version of React right now.

yarn add react@experimental react-dom@experimental

Since this library relies on an impure render to collect refs, it is not advised for use on the server and should rather be accessed imperatively after JavaScript has loaded.

useRefList () => [refs, useRef]

The main export that returns an array of refs as well as an instance hook that's used to subscribe refs.

refs { current: [{ ref, key }] }

This is a collection of the currently subscribed refs.

useRef (key, initialValue) => [ref, index]

This should be used in place of the normal React.useRef. The ref will be collected at each call site and added to the returned refs array from useRefList.

This hook should only be called once in a component.

Example

import * as React from 'react'
import { useRefList } from 'use-ref-list'

function ListItem({ useRef, children }) {
  const id = React.unstable_useOpaqueIdentifier()
  const [ref, refIndex] = useRef(id)
  return (
    <li ref={ref}>
      {children} {refIndex}
    </li>
  )
}

function App() {
  const [refs, useRef] = useRefList()
  React.useLayoutEffect(() => {
    // access to all collected refs
    console.log(refs.current)
  }, [])
  return (
    <ul>
      <ListItem useRef={useRef}>Item 1</ListItem>
      <ListItem useRef={useRef}>Item 2</ListItem>
      <ListItem useRef={useRef}>Item 3</ListItem>
    </ul>
  )
}