Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix overloads in createAnimatedComponent #5463

Merged
merged 3 commits into from
Dec 14, 2023
Merged

Fix overloads in createAnimatedComponent #5463

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
537d266
Fix overloads
Dec 4, 2023
462b803
Merge branch 'main' into acynk/createAnimatedCOmponent-overload-fix
Dec 12, 2023
59e9e14
Merge branch 'main' into acynk/createAnimatedCOmponent-overload-fix
Dec 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions src/createAnimatedComponent/createAnimatedComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,7 @@ type Options<P> = {
* @see https://docs.swmansion.com/react-native-reanimated/docs/core/createAnimatedComponent
*/

/**
* @deprecated Please use `Animated.FlatList` component instead of calling `Animated.createAnimatedComponent(FlatList)` manually.
*/
// @ts-ignore This is required to create this overload, since type of createAnimatedComponent is incorrect and doesn't include typeof FlatList
export function createAnimatedComponent(
component: typeof FlatList<unknown>,
options?: Options<any>
): ComponentClass<AnimateProps<FlatListProps<unknown>>>;

// Don't change the order of overloads, since such a change breaks current behavior
Latropos marked this conversation as resolved.
Show resolved Hide resolved
export function createAnimatedComponent<P extends object>(
component: FunctionComponent<P>,
options?: Options<P>
Expand All @@ -106,6 +98,22 @@ export function createAnimatedComponent<P extends object>(
options?: Options<P>
): ComponentClass<AnimateProps<P>>;

export function createAnimatedComponent<P extends object>(
// Actually ComponentType<P = {}> = ComponentClass<P> | FunctionComponent<P> but we need this overload too
// since some external components (like FastImage) are typed just as ComponentType
component: ComponentType<P>,
options?: Options<P>
): FunctionComponent<AnimateProps<P>> | ComponentClass<AnimateProps<P>>;

/**
* @deprecated Please use `Animated.FlatList` component instead of calling `Animated.createAnimatedComponent(FlatList)` manually.
*/
// @ts-ignore This is required to create this overload, since type of createAnimatedComponent is incorrect and doesn't include typeof FlatList
export function createAnimatedComponent(
component: typeof FlatList<unknown>,
options?: Options<any>
Latropos marked this conversation as resolved.
Show resolved Hide resolved
): ComponentClass<AnimateProps<FlatListProps<unknown>>>;

export function createAnimatedComponent(
Component: ComponentType<InitialComponentProps>,
options?: Options<InitialComponentProps>
Expand Down