# merge-refs

> A function that merges React refs into one.

Latest version **2.0.0** (published 2025-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install merge-refs
pnpm add merge-refs
yarn add merge-refs
bun add merge-refs
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2025-03-20 |
| First published | 2020-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 116 |
| Author | Wojciech Maj |
| Maintainers | wojtekmaj |
| Keywords | react, react ref, react refs, merge |

## Links

- npm: https://www.npmjs.com/package/merge-refs
- Repository: https://github.com/wojtekmaj/merge-refs
- Homepage: https://github.com/wojtekmaj/merge-refs#readme
- Issues: https://github.com/wojtekmaj/merge-refs/issues
- Funding: https://github.com/wojtekmaj/merge-refs?sponsor=1
- npm.io page: https://npm.io/package/merge-refs

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2025-03-20
- 1.3.0 — 2024-04-30
- 1.2.2 — 2023-10-18
- 1.2.1 — 2023-05-29
- 1.2.0 — 2023-05-29
- 1.1.3 — 2023-03-31
- 1.1.2 — 2023-02-02
- 1.1.1 — 2023-01-30
- 1.1.0 — 2023-01-09
- 1.0.0 — 2020-02-14

## README

[![npm](https://img.shields.io/npm/v/merge-refs.svg)](https://www.npmjs.com/package/merge-refs) ![downloads](https://img.shields.io/npm/dt/merge-refs.svg) [![CI](https://github.com/wojtekmaj/merge-refs/actions/workflows/ci.yml/badge.svg)](https://github.com/wojtekmaj/merge-refs/actions)

# Merge-Refs

A function that merges React refs into one. Filters out invalid (eg. falsy) refs as well and returns original ref if only one valid ref was given.

## tl;dr

- Install by executing `npm install merge-refs` or `yarn add merge-refs`.
- Import by adding `import mergeRefs from 'merge-refs'`.
- Use it in `ref` like so: `<div ref={mergeRefs(ref, someOtherRef)} />`

## Accepted refs

- Refs created using `createRef()`
- Refs created using `useRef()`
- Functional refs

## Example

```tsx
function Hello() {
  const ref1 = useRef<HTMLDivElement>(); // I'm going to be updated!
  const ref2 = (element: HTMLDivElement) => {
    // I'm going to be called!
  };

  return <div ref={mergeRefs(ref1, ref2)} />;
}
```

## License

The MIT License.

## Author

<table>
  <tr>
    <td >
      <img src="https://avatars.githubusercontent.com/u/5426427?v=4&s=128" width="64" height="64" alt="Wojciech Maj">
    </td>
    <td>
      <a href="https://github.com/wojtekmaj">Wojciech Maj</a>
    </td>
  </tr>
</table>

---
_Source: https://npm.io/package/merge-refs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._