# react-merge-refs

> React utility to merge refs.

Latest version **3.0.2** (published 2025-05-08) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 40/100 (D)** — status: maintenance-mode.

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

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2025-05-08 |
| First published | 2019-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 671 |
| Author | Greg Bergé |
| Maintainers | neoziro |
| Keywords | react, utility, ref |

## Links

- npm: https://www.npmjs.com/package/react-merge-refs
- Repository: https://github.com/gregberge/react-merge-refs
- Homepage: https://github.com/gregberge/react-merge-refs#readme
- Issues: https://github.com/gregberge/react-merge-refs/issues
- Funding: https://github.com/sponsors/gregberge
- npm.io page: https://npm.io/package/react-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

- 3.0.2 (latest) — 2025-05-08
- 3.0.1 — 2025-04-28
- 3.0.0 — 2025-04-27
- 2.1.1 — 2023-09-28
- 2.1.0 — 2023-09-28
- 2.0.2 — 2023-05-09
- 2.0.1 — 2022-06-27
- 2.0.0 — 2022-06-19
- 1.1.0 — 2020-07-27
- 1.0.0 — 2019-09-19

## README

# react-merge-refs

[![License](https://img.shields.io/npm/l/react-merge-refs.svg)](https://github.com/gregberge/react-merge-refs/blob/main/LICENSE)
[![npm package](https://img.shields.io/npm/v/react-merge-refs/latest.svg)](https://www.npmjs.com/package/react-merge-refs)
[![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-merge-refs)](https://bundlephobia.com/package/react-merge-refs)
[![CI](https://github.com/gregberge/react-merge-refs/actions/workflows/ci.yml/badge.svg)](https://github.com/gregberge/react-merge-refs/actions/workflows/ci.yml)

React utility to merge refs 🖇

```sh
npm install react-merge-refs
```

## Example

```js
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

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