Skip to content

Update createAnimatedComponent type to be correctly translatable to TypeScript #49881

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

Closed
j-piasecki wants to merge 1 commit into from
Closed

Update createAnimatedComponent type to be correctly translatable to TypeScript #49881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 24 additions & 12 deletions packages/react-native/Libraries/Animated/createAnimatedComponent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export type StrictAnimatedProps<Props: {...}> = $ReadOnly<{
}>;

export type AnimatedComponentType<Props: {...}, +Instance = mixed> = component(
ref: React.RefSetter<Instance>,
ref?: React.RefSetter<Instance>,
...AnimatedProps<Props>
);

Expand All @@ -45,29 +45,41 @@ export type StrictAnimatedComponentType<
+Instance = mixed,
> = component(ref: React.RefSetter<Instance>, ...StrictAnimatedProps<Props>);

export default function createAnimatedComponent<TProps: {...}, TInstance>(
Component: component(ref: React.RefSetter<TInstance>, ...TProps),
): AnimatedComponentType<TProps, TInstance> {
export default function createAnimatedComponent<
TInstance: React.ComponentType<any>,
>(
Component: TInstance,
): AnimatedComponentType<
$ReadOnly<React.ElementProps<TInstance>>,
React.ElementRef<TInstance>,
> {
return unstable_createAnimatedComponentWithAllowlist(Component, null);
}

export function unstable_createAnimatedComponentWithAllowlist<
TProps: {...},
TInstance,
TInstance: React.ComponentType<TProps>,
>(
Component: component(ref: React.RefSetter<TInstance>, ...TProps),
Component: TInstance,
allowlist: ?AnimatedPropsAllowlist,
): StrictAnimatedComponentType<TProps, TInstance> {
): StrictAnimatedComponentType<TProps, React.ElementRef<TInstance>> {
const useAnimatedProps = createAnimatedPropsHook(allowlist);

const AnimatedComponent = React.forwardRef<
const AnimatedComponent: StrictAnimatedComponentType<
TProps,
React.ElementRef<TInstance>,
> = React.forwardRef<
StrictAnimatedProps<TProps>,
TInstance,
React.ElementRef<TInstance>,
>((props, forwardedRef) => {
const [reducedProps, callbackRef] = useAnimatedProps<TProps, TInstance>(
props,
const [reducedProps, callbackRef] = useAnimatedProps<
TProps,
React.ElementRef<TInstance>,
>(props);
const ref = useMergeRefs<React.ElementRef<TInstance>>(
callbackRef,
forwardedRef,
);
const ref = useMergeRefs<TInstance>(callbackRef, forwardedRef);

// Some components require explicit passthrough values for animation
// to work properly. For example, if an animated component is
Expand Down
18 changes: 10 additions & 8 deletions packages/react-native/Libraries/__tests__/__snapshots__/public-api-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,24 +648,26 @@ export type StrictAnimatedProps<Props: { ... }> = $ReadOnly<{
export type AnimatedComponentType<
Props: { ... },
+Instance = mixed,
> = component(ref: React.RefSetter<Instance>, ...AnimatedProps<Props>);
> = component(ref?: React.RefSetter<Instance>, ...AnimatedProps<Props>);
export type StrictAnimatedComponentType<
Props: { ... },
+Instance = mixed,
> = component(ref: React.RefSetter<Instance>, ...StrictAnimatedProps<Props>);
declare export default function createAnimatedComponent<
TProps: { ... },
TInstance,
TInstance: React.ComponentType<any>,
>(
Component: component(ref: React.RefSetter<TInstance>, ...TProps)
): AnimatedComponentType<TProps, TInstance>;
Component: TInstance
): AnimatedComponentType<
$ReadOnly<React.ElementProps<TInstance>>,
React.ElementRef<TInstance>,
>;
declare export function unstable_createAnimatedComponentWithAllowlist<
TProps: { ... },
TInstance,
TInstance: React.ComponentType<TProps>,
>(
Component: component(ref: React.RefSetter<TInstance>, ...TProps),
Component: TInstance,
allowlist: ?AnimatedPropsAllowlist
): StrictAnimatedComponentType<TProps, TInstance>;
): StrictAnimatedComponentType<TProps, React.ElementRef<TInstance>>;
"
`;

Expand Down