UNPKG

use-callback-ref

Version:
17 lines (16 loc) 645 B
import { MutableRefObject } from 'react'; import { ReactRef } from './types'; /** * Merges two or more refs together providing a single interface to set their value * @param {RefObject|Ref} refs * @returns {MutableRefObject} - a new ref, which translates all changes to {refs} * * @see {@link useMergeRefs} to be used in ReactComponents * @example * const Component = React.forwardRef((props, ref) => { * const ownRef = useRef(); * const domRef = mergeRefs([ref, ownRef]); // 👈 merge together * return <div ref={domRef}>...</div> * } */ export declare function mergeRefs<T>(refs: ReactRef<T>[]): MutableRefObject<T | null>;