npm.io
1.3.2 • Published 4 years ago

@react-hook/merged-ref

Licence
MIT
Version
1.3.2
Deps
0
Size
16 kB
Vulns
0
Weekly
0
Stars
1.5K

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

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

Keywords