fix: AppType generic parameter applies to props, not pageProps#92963
Open
Jah-yee wants to merge 1 commit intovercel:canaryfrom
Open
fix: AppType generic parameter applies to props, not pageProps#92963Jah-yee wants to merge 1 commit intovercel:canaryfrom
Jah-yee wants to merge 1 commit intovercel:canaryfrom
Conversation
The generic parameter P passed to AppType<P> was incorrectly placed inside pageProps by AppPropsType. With this change, P is merged directly onto the props object, so custom props are accessible directly (e.g., foo) rather than only via pageProps.foo. Fixes vercel#42846
Collaborator
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
1 similar comment
Collaborator
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
This file contains hidden or 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
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.
Fix: AppType generic parameter misuse (closes #42846)
Problem
Prop types defined by the generic parameter on
AppTypewere incorrectly applied toMyApp'sprops.pagePropsinstead ofMyApp'sprops.Example from issue:
Error:
Property 'foo' does not exist on type 'AppPropsType<any, MyInitialProps>'Root Cause
In
AppPropsType<Router, PageProps>, thePagePropstype was nested insideAppInitialProps<PageProps>which wraps it as{ pageProps: PageProps }. This caused custom props to end up insidepagePropsrather than on the root props object.Fix
Changed
AppPropsTypeto mergePagePropsdirectly onto the root props object:This ensures:
foo) are directly onpropspagePropsfield still exists with the same type for backwards compatibilityBreaking Changes
None —
pagePropsis still accessible, just also exposes custom props at the root level (which is the expected behavior based on how_appactually works at runtime).