react-merge-refs
TypeScript icon, indicating that this package has built-in type declarations

2.0.2 • Public • Published

react-merge-refs

License npm package npm bundle size CI

React utility to merge refs 🖇

npm install react-merge-refs

Example

import React from "react";
import { mergeRefs } from "react-merge-refs";

const Example = React.forwardRef(function Example(props, ref) {
  const localRef = React.useRef();
  return <div ref={mergeRefs([localRef, ref])} />;
});

Why?

When developing low level UI components, it is common to have to use a local ref but also support an external one using React.forwardRef. Natively, React does not offer a way to set two refs inside the ref property. This is the goal of this small utility.

Today a ref can be a function or an object, tomorrow it could be another thing, who knows. This utility handles compatibility for you.

License

MIT

Readme

Keywords

Package Sidebar

Install

DownloadsWeekly Downloads

821,011

Version

2.0.2

License

MIT

Unpacked Size

5.26 kB

Total Files

6

Last publish

Collaborators

  • neoziro