react-native-reanimated/lib/typescript/createAnimatedComponent/setAndForwardRef.d.ts

More powerful alternative to Animated library for React Native.

/**
 * imported from react-native
 */
import type { MutableRefObject } from 'react';
/**
 * This is a helper function for when a component needs to be able to forward a ref
 * to a child component, but still needs to have access to that component as part of
 * its implementation.
 *
 * Its main use case is in wrappers for native components.
 *
 * Usage:
 *
 *   class MyView extends React.Component {
 *     _nativeRef = null;
 *
 *     _setNativeRef = setAndForwardRef({
 *       getForwardedRef: () => this.props.forwardedRef,
 *       setLocalRef: ref => {
 *         this._nativeRef = ref;
 *       },
 *     });
 *
 *     render() {
 *       return <View ref={this._setNativeRef} />;
 *     }
 *   }
 *
 *   const MyViewWithRef = React.forwardRef((props, ref) => (
 *     <MyView {...props} forwardedRef={ref} />
 *   ));
 *
 *   module.exports = MyViewWithRef;
 */
type ForwardedRef<T> = () => MutableRefObject<T> | ((ref: T) => void);
declare function setAndForwardRef<T>({ getForwardedRef, setLocalRef, }: {
    getForwardedRef: ForwardedRef<T>;
    setLocalRef: (ref: T) => void;
}): (ref: T) => void;
export default setAndForwardRef;