Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@react-hook/merged-ref

jaredLunde184.6kMIT1.3.2TypeScript support: included

A React hook for merging multiple refs into one ref

react, react hook, merged ref, merge two refs, combine refs, multiple refs, merge refs, merge react refs, usemergerefs, use merge refs, usemergedref, use merged ref

readme


useMergedRef()

Bundlephobia Types Build status NPM Version MIT License

npm i @react-hook/merged-ref

A React hook for merging multiple refs into one ref

Quick Start

`jsx harmony import React from 'react' import useMergedRef from '@react-hook/merged-ref'

const Component = React.forwardRef((props, ref) => { const otherRef = React.useRef(null) const multiRef = useMergedRef(ref, otherRef) return

})


## API

### `useMergedRef(...refs)`

```ts
function useMergedRef<T>(...refs: React.Ref<T>[]): React.RefCallback<T>
Argument Description
refs React callback refs or refs created with useRef(), createRef()

Returns React.RefCallback

Returns a callback ref

LICENSE

MIT