react-native-reanimated
Version:
More powerful alternative to Animated library for React Native.
15 lines (14 loc) • 1.1 kB
TypeScript
import type { DependencyList } from './commonTypes';
import type { AnimatedPropsAdapterFunction } from '../commonTypes';
type UseAnimatedProps = <Props extends object>(updater: () => Partial<Props>, dependencies?: DependencyList | null, adapters?: AnimatedPropsAdapterFunction | AnimatedPropsAdapterFunction[] | null, isAnimatedProps?: boolean) => Partial<Props>;
/**
* Lets you create an animated props object which can be animated using shared values.
*
* @param updater - A function returning an object with properties you want to animate.
* @param dependencies - An optional array of dependencies. Only relevant when using Reanimated without the Babel plugin on the Web.
* @param adapters - An optional function or array of functions allowing to adopt prop naming between JS and the native side.
* @returns An animated props object which has to be passed to `animatedProps` property of an Animated component that you want to animate.
* @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedProps
*/
export declare const useAnimatedProps: UseAnimatedProps;
export {};