@primer/react
Version:
An implementation of GitHub's Primer Design System using React
22 lines • 862 B
TypeScript
import type { ForwardedRef, RefObject } from 'react';
/**
* Use a ref object as the imperative handle for a forwarded ref. This can be used to
* synchronize the ref object with the forwarded ref and allow local access the reference
* instance with `.current`.
*
* **NOTE**: The `refObject` should be passed to the underlying element, NOT the `forwardedRef`.
*
* @deprecated Migrate to `useMergedRefs`. It's safer, faster, and easier to use:
*
* ```diff
* const ref = useRef(null)
*
* - useRefObjectAsForwardedRef(forwardedRef, ref)
* + const mergedRef = useMergedRefs(forwardedRef, ref)
*
* - return <div ref={ref} />
* + return <div ref={mergedRef} />
* ```
*/
export declare function useRefObjectAsForwardedRef<T>(forwardedRef: ForwardedRef<T>, refObject: RefObject<T | null>): void;
//# sourceMappingURL=useRefObjectAsForwardedRef.d.ts.map