fix: wrong setParams type if route does not have params #10512
Merged
Conversation
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
If a RouteList type has a route with params set to undefined, for example:
```ts
type ExampleRouteList = {
HasArgs: {someArg?: string};
NoArgs: undefined;
};
```
Then `navigation.setParams` for `NoArgs` would be typed as `(params: Partial<unknown>): void`, since
`NavigationProp` would type it as `(params: Partial<RouteList[RouteName]>): void`.
This would cause issues with `CompositeScreenProps` because a route with `undefined` params
would not extend the `NavigationProp` type correctly, so that screen would not actually get
all the options the parent navigators have available.
Conditionally setting `setParams` to `undefined` if `RouteList[RouteName]` extends `undefined`
fixes this issue.
|
Hey Gustash! Thanks for opening your first pull request in this repo. If you haven't already, make sure to read our contribution guidelines. |
✅ Deploy Preview for react-navigation-example ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
@satya164 can I get a review here? Shouldn't take too long |
|
Waiting on this one. |
Codecov Report
@@ Coverage Diff @@
## main #10512 +/- ##
=======================================
Coverage 73.87% 73.87%
=======================================
Files 160 160
Lines 4992 4992
Branches 1949 1949
=======================================
Hits 3688 3688
Misses 1267 1267
Partials 37 37 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Fixes #10471
If a RouteList type has a route with params set to undefined, for example:
Then
navigation.setParamsforNoArgswould be typed as(params: Partial<unknown>): void, sinceNavigationPropwould type it as(params: Partial<RouteList[RouteName]>): void.This would cause issues with
CompositeScreenPropsbecause a route withundefinedparams would not extend theNavigationProptype correctly, so that screen would not actually get all the options the parent navigators have available.Conditionally setting
setParamstoundefinedifRouteList[RouteName]extendsundefinedfixes this issue.Test plan
Adding a test case in
example/types.check.tsxforLatestScreen, which has params set toundefined, showed that this was indeed an issue becausesetOptionswould fail the checks.After the fix, these checks now pass for all screens, including the
LatestScreen.I also fixed the
setOptionstype checks so that they explicitly check that all the parent navigator screen options are available, instead of just a hand-full.Code formatting
yarn test,yarn lintandyarn typescriptall pass with these changes, and I have ran them locally before commiting.