UNPKG

1.17 kBTypeScriptView Raw
1import type { DependencyList } from './commonTypes';
2import type { AnimatedPropsAdapterFunction } from '../commonTypes';
3type UseAnimatedProps = <Props extends object>(updater: () => Partial<Props>, dependencies?: DependencyList | null, adapters?: AnimatedPropsAdapterFunction | AnimatedPropsAdapterFunction[] | null, isAnimatedProps?: boolean) => Partial<Props>;
4/**
5 * Lets you create an animated props object which can be animated using shared
6 * values.
7 *
8 * @param updater - A function returning an object with properties you want to
9 * animate.
10 * @param dependencies - An optional array of dependencies. Only relevant when
11 * using Reanimated without the Babel plugin on the Web.
12 * @param adapters - An optional function or array of functions allowing to
13 * adopt prop naming between JS and the native side.
14 * @returns An animated props object which has to be passed to `animatedProps`
15 * property of an Animated component that you want to animate.
16 * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedProps
17 */
18export declare const useAnimatedProps: UseAnimatedProps;
19export {};
20//# sourceMappingURL=useAnimatedProps.d.ts.map
\No newline at end of file