@react-hook/merged-ref

v1.0.2
A React hook for merging multiple refs into one ref
react react hook merged ref merge two refs combine refs multiple refs


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

npm i @react-hook/[email protected]

Metadata

  • MIT
  • Whatever
  • Jared Lunde
  • released 9/18/2019

Downloads

Maintainers