UNPKG

react-native-reanimated

Version:

More powerful alternative to Animated library for React Native.

207 lines (183 loc) • 6.44 kB
'use strict'; /* This file is a legacy remainder of manual types from react-native-reanimated.d.ts file. I wasn't able to get rid of all of them from the code. They should be treated as a temporary solution until time comes to refactor the code and get necessary types right. This will not be easy though! */ 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'; 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; // Ideally we want AnimatedStyle to not be generic, but there are // so many depenedencies on it being generic that it's not feasible at the moment. export type AnimatedStyle<Style = DefaultStyle> = | Style | MaybeSharedValueRecursive<Style>; type EntryOrExitLayoutType = | BaseAnimationBuilder | typeof BaseAnimationBuilder | EntryExitAnimationFunction | ReanimatedKeyframe; /* Style type properties (properties that extends StyleProp<ViewStyle>) can be defined with other property names than "style". For example `contentContainerStyle` in FlatList. Type definition for all style type properties should act similarly, hence we pick keys with 'Style' substring with the use of this utility type. */ 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 = { /** * Lets you animate the layout changes when components are added to or removed from the view hierarchy. * * You can use the predefined layout transitions (eg. `LinearTransition`, `FadingTransition`) or create your own ones. * * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions */ layout?: | BaseAnimationBuilder | LayoutAnimationFunction | typeof BaseAnimationBuilder; /** * Lets you animate an element when it's added to or removed from the view hierarchy. * * You can use the predefined entering animations (eg. `FadeIn`, `SlideInLeft`) or create your own ones. * * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations */ entering?: EntryOrExitLayoutType; /** * Lets you animate an element when it's added to or removed from the view hierarchy. * * You can use the predefined entering animations (eg. `FadeOut`, `SlideOutRight`) or create your own ones. * * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations */ exiting?: EntryOrExitLayoutType; }; type SharedTransitionProps = { /** * Lets you animate components between two navigation screens. * * Assign the same `sharedTransitionTag` to [animated components](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component) on two different navigation screens to create a shared transition. * * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview * @experimental */ sharedTransitionTag?: string; /** * Lets you create a custom shared transition animation. * * Used alongside `SharedTransition.custom()` method. * * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview * @experimental */ 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 & { /** * Lets you animate component props. * * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedProps */ animatedProps?: Partial<AnimatedPropsProp<Props>>; }; // THE LAND OF THE DEPRECATED /** * @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 {@link TransformArrayItem} type instead. */ export type TransformStyleTypes = TransformArrayItem; /** * @deprecated Please use {@link 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 {@link AnimatedProps} type instead. */ export type AnimateProps<Props extends object> = AnimatedProps<Props>;