-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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.
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
[No QA] [TS Migration] migrate withNavigation.js to TypeScript #29531
Merged
dangrous
merged 6 commits into
Expensify:main
from
JKobrynski:migrateWithNavigationToTypeScript
Oct 19, 2023
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9ed2eaa
migrate HOC to TypeScript, remove proptypes
JKobrynski b646d2f
remove unnecessary eslint disable
JKobrynski 0017918
remove type casting from getCOmponentDisplayName
JKobrynski d841420
fix typo in eslintrc
JKobrynski 1c09561
fix navigation prop types
JKobrynski 6119982
add return type to hoc
JKobrynski File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
import React, {ComponentType, ForwardedRef, RefAttributes} from 'react'; | ||
import {NavigationProp, useNavigation} from '@react-navigation/native'; | ||
import getComponentDisplayName from '../libs/getComponentDisplayName'; | ||
|
||
type WithNavigationProps = { | ||
navigation: NavigationProp<ReactNavigation.RootParamList>; | ||
}; | ||
|
||
export default function withNavigation<TProps extends WithNavigationProps, TRef>( | ||
WrappedComponent: ComponentType<TProps & RefAttributes<TRef>>, | ||
): (props: Omit<TProps, keyof WithNavigationProps>, ref: ForwardedRef<TRef>) => React.JSX.Element | null { | ||
function WithNavigation(props: Omit<TProps, keyof WithNavigationProps>, ref: ForwardedRef<TRef>) { | ||
const navigation = useNavigation(); | ||
return ( | ||
<WrappedComponent | ||
// eslint-disable-next-line react/jsx-props-no-spreading | ||
{...(props as TProps)} | ||
ref={ref} | ||
navigation={navigation} | ||
/> | ||
); | ||
} | ||
|
||
WithNavigation.displayName = `withNavigation(${getComponentDisplayName(WrappedComponent)})`; | ||
return React.forwardRef(WithNavigation); | ||
} |
7 changes: 5 additions & 2 deletions
7
src/libs/Navigation/AppNavigator/Navigators/RightModalNavigator.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
import {ComponentType} from 'react'; | ||
|
||
/** Returns the display name of a component */ | ||
export default function getComponentDisplayName(component: ComponentType): string { | ||
export default function getComponentDisplayName<TProps>(component: ComponentType<TProps>): string { | ||
return component.displayName ?? component.name ?? 'Component'; | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NAB - why this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure thing, let me explain! So when it comes to lines 9-11 (and typing HOCs in general) we are following guidelines from these two sources:
it's the same approach in all TypeScript HOC PRs, that's something we agreed upon. About
PascalCase
, it's necessary because in HOCs components (WrappedComponent
) are passed as function parameters.Hope that answers your questions, if there is anything else you'd like me to explain let me know!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ooh got it. Cool, that makes sense!