@react-hook/merged-ref
v1.3.2
Published
A React hook for merging multiple refs into one ref
Downloads
113,055
Maintainers
Readme
A React hook for merging multiple refs into one ref
Quick Start
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 <div ref={multiRef} />
})
API
useMergedRef(...refs)
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