1.3.2 • Published 3 years ago

@react-hook/merged-ref v1.3.2

Weekly downloads
18,028
License
MIT
Repository
github
Last release
3 years ago

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>
ArgumentDescription
refsReact callback refs or refs created with useRef(), createRef()

Returns React.RefCallback

Returns a callback ref

LICENSE

MIT