react-native-reanimated/lib/typescript/reanimated2/helperTypes.d.ts

More powerful alternative to Animated library for React Native.

import type { ColorValue, StyleProp, TransformsStyle as RNTransformsStyle } from 'react-native';
import type { AnimatableValue, BaseAnimationBuilder, EntryExitAnimationFunction, LayoutAnimationFunction, SharedValue } from '.';
import type { ReanimatedKeyframe } from './layoutReanimation/animationBuilder/Keyframe';
import type { SharedTransition } from './layoutReanimation/sharedTransitions';
import type { DependencyList } from './hook/commonTypes';
export type Adaptable<T> = T | ReadonlyArray<T | ReadonlyArray<T>> | SharedValue<T>;
export type AdaptTransforms<T> = {
    [P in keyof T]: Adaptable<T[P]>;
};
type TransformsStyle = Pick<RNTransformsStyle, 'transform'>;
export type TransformStyleTypes = TransformsStyle['transform'] extends readonly (infer T)[] | string | undefined ? T : never;
export type AnimatedTransform = AdaptTransforms<TransformStyleTypes>[];
/**
 * @deprecated Please use `AnimatedStyle` type instead.
 */
export type AnimateStyle<S> = {
    [K in keyof S]: K extends 'transform' ? AnimatedTransform : S[K] extends ReadonlyArray<any> ? ReadonlyArray<AnimateStyle<S[K][0]>> : S[K] extends object ? AnimateStyle<S[K]> : S[K] extends ColorValue | undefined ? S[K] | number : S[K] | SharedValue<AnimatableValue>;
};
export type AnimatedStyle<S> = AnimateStyle<S>;
type MaybeSharedValue<S> = {
    [K in keyof S]: S[K] | Readonly<SharedValue<Extract<S[K], AnimatableValue>>>;
};
export type StylesOrDefault<T> = 'style' extends keyof T ? MaybeSharedValue<T['style']> : Record<string, unknown>;
type EntryOrExitLayoutType = BaseAnimationBuilder | typeof BaseAnimationBuilder | EntryExitAnimationFunction | ReanimatedKeyframe;
type PickStyleProps<T> = Pick<T, {
    [Key in keyof T]-?: Key extends `${string}Style` ? Key : never;
}[keyof T]>;
type StyleAnimatedProps<P extends object> = {
    [K in keyof PickStyleProps<P>]: StyleProp<AnimatedStyle<P[K] | MaybeSharedValue<P[K]>>>;
};
type JustStyleAnimatedProp<P extends object> = {
    style?: StyleProp<AnimatedStyle<StylesOrDefault<P>>>;
};
type NonStyleAnimatedProps<P extends object> = {
    [K in keyof Omit<P, keyof PickStyleProps<P> | 'style'>]: P[K] | SharedValue<P[K]>;
};
type LayoutProps = {
    layout?: BaseAnimationBuilder | LayoutAnimationFunction | typeof BaseAnimationBuilder;
    entering?: EntryOrExitLayoutType;
    exiting?: EntryOrExitLayoutType;
};
type SharedTransitionProps = {
    sharedTransitionTag?: string;
    sharedTransitionStyle?: SharedTransition;
};
type AnimatedPropsProp<P extends object> = NonStyleAnimatedProps<P> & JustStyleAnimatedProp<P> & StyleAnimatedProps<P> & LayoutProps & SharedTransitionProps;
export type AnimateProps<P extends object> = NonStyleAnimatedProps<P> & JustStyleAnimatedProp<P> & StyleAnimatedProps<P> & LayoutProps & SharedTransitionProps & {
    animatedProps?: Partial<AnimatedPropsProp<P>>;
};
export type AnimatedProps<P extends object> = AnimateProps<P>;
export type AnimatedPropsAdapterFunction = (props: Record<string, unknown>) => void;
export type useAnimatedPropsType = <T extends object>(updater: () => Partial<T>, deps?: DependencyList | null, adapters?: AnimatedPropsAdapterFunction | AnimatedPropsAdapterFunction[] | null) => Partial<T>;
export {};