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

More powerful alternative to Animated library for React Native.

import type { ImageStyle, RegisteredStyle, StyleProp, TextStyle, TransformsStyle, ViewStyle } from 'react-native';
import type { AnimatableValue, SharedValue } from './commonTypes';
import type { BaseAnimationBuilder } from './layoutReanimation/animationBuilder/BaseAnimationBuilder';
import type { EntryExitAnimationFunction, LayoutAnimationFunction } from './layoutReanimation/animationBuilder/commonTypes';
import type { ReanimatedKeyframe } from './layoutReanimation/animationBuilder/Keyframe';
import type { SharedTransition } from './layoutReanimation/sharedTransitions';
import type { DependencyList } from './hook/commonTypes';
export type TransformArrayItem = Extract<TransformsStyle['transform'], Array<unknown>>[number];
export type AnimatedTransform = MaybeSharedValueRecursive<TransformsStyle['transform']>;
type MaybeSharedValue<Value> = Value | Value extends AnimatableValue ? SharedValue<Value> : never;
type MaybeSharedValueRecursive<Value> = Value extends (infer Item)[] ? SharedValue<Item[]> | (MaybeSharedValueRecursive<Item> | Item)[] : Value extends object ? SharedValue<Value> | {
    [Key in keyof Value]: MaybeSharedValueRecursive<Value[Key]> | Value[Key];
} : MaybeSharedValue<Value>;
type DefaultStyle = ViewStyle & ImageStyle & TextStyle;
export type AnimatedStyle<Style = DefaultStyle> = Style | MaybeSharedValueRecursive<Style>;
type EntryOrExitLayoutType = BaseAnimationBuilder | typeof BaseAnimationBuilder | EntryExitAnimationFunction | ReanimatedKeyframe;
type PickStyleProps<Props> = Pick<Props, {
    [Key in keyof Props]-?: Key extends `${string}Style` | 'style' ? Key : never;
}[keyof Props]>;
type AnimatedStyleProps<Props extends object> = {
    [Key in keyof PickStyleProps<Props>]: StyleProp<AnimatedStyle<Props[Key]>>;
};
/**
 * Component props that are not specially handled by us.
 */
type RestProps<Props extends object> = {
    [K in keyof Omit<Props, keyof PickStyleProps<Props> | 'style'>]: Props[K] | SharedValue<Props[K]>;
};
type LayoutProps = {
    layout?: BaseAnimationBuilder | LayoutAnimationFunction | typeof BaseAnimationBuilder;
    entering?: EntryOrExitLayoutType;
    exiting?: EntryOrExitLayoutType;
};
type SharedTransitionProps = {
    sharedTransitionTag?: string;
    sharedTransitionStyle?: SharedTransition;
};
type AnimatedPropsProp<Props extends object> = RestProps<Props> & AnimatedStyleProps<Props> & LayoutProps & SharedTransitionProps;
export type AnimatedProps<Props extends object> = RestProps<Props> & AnimatedStyleProps<Props> & LayoutProps & SharedTransitionProps & {
    animatedProps?: Partial<AnimatedPropsProp<Props>>;
};
export type AnimatedPropsAdapterFunction = (props: Record<string, unknown>) => void;
export type useAnimatedPropsType = <Props extends object>(updater: () => Partial<Props>, deps?: DependencyList | null, adapters?: AnimatedPropsAdapterFunction | AnimatedPropsAdapterFunction[] | null, isAnimatedProps?: boolean) => Partial<Props>;
/**
 * @deprecated This type is no longer relevant.
 */
export type Adaptable<T> = T | ReadonlyArray<T | ReadonlyArray<T>> | SharedValue<T>;
/**
 * @deprecated This type is no longer relevant.
 */
export type AdaptTransforms<T> = {
    [P in keyof T]: Adaptable<T[P]>;
};
/**
 * @deprecated Please use `TransformArrayItem` type instead.
 */
export type TransformStyleTypes = TransformArrayItem;
/**
 * @deprecated Please use `AnimatedStyle` type instead.
 */
export type AnimateStyle<Style = DefaultStyle> = AnimatedStyle<Style>;
/**
 * @deprecated This type is no longer relevant.
 */
export type StylesOrDefault<T> = 'style' extends keyof T ? MaybeSharedValueRecursive<T['style']> : Record<string, unknown>;
/**
 * @deprecated This type is no longer relevant.
 */
export type AnimatedStyleProp<T> = AnimatedStyle<T> | RegisteredStyle<AnimatedStyle<T>>;
/**
 * @deprecated Please use `AnimatedProps` type instead.
 */
export type AnimateProps<Props extends object> = AnimatedProps<Props>;
export {};