@mui/utils
Version:
Utility functions for React components.
18 lines • 670 B
TypeScript
import * as React from 'react';
/**
* Takes an array of refs and returns a new ref which will apply any modification to all of the refs.
* This is useful when you want to have the ref used in multiple places.
*
* ```tsx
* const rootRef = React.useRef<Instance>(null);
* const refFork = useForkRef(rootRef, props.ref);
*
* return (
* <Root {...props} ref={refFork} />
* );
* ```
*
* @param {Array<React.Ref<Instance> | undefined>} refs The ref array.
* @returns {React.RefCallback<Instance> | null} The new ref callback.
*/
export default function useForkRef<Instance>(...refs: Array<React.Ref<Instance> | undefined>): React.RefCallback<Instance> | null;