@react-hook/merged-ref

A React hook for merging multiple refs into one ref

Usage no npm install needed!

<script type="module">
  import reactHookMergedRef from 'https://cdn.skypack.dev/@react-hook/merged-ref';
</script>

README


useMergedRef()

Bundlephobia Types 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 extends any>(
  ...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