[Card] Fix TypeScript not recognizing "component" prop #20179
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
… (title & subheader)
Details of bundle changes.Comparing: 14f5de6...30c75b8 Details of page changes
|
rart
commented
Mar 19, 2020
Comment on lines
93
to
99
| <CardHeader | ||
| titleTypographyProps={{ | ||
| component: 'a', | ||
| // $ExpectError | ||
| propThatDoesntExist: 'shouldNotWork', | ||
| }} | ||
| />; |
There was a problem hiding this comment.
@eps1lon @fyodore82 need some advice...
CardHeader has an additional level of complexity compared to ListItemText in that it's a type map.
The component prop on both titleTypographyProps & subheaderTypographyProps now works as expected. However I can't seem to find the way to get these particular set of tests to fail — the tests that look into unknown props on typography object. The nested typography prop objects accept any number of unknown props. The correct typography props work as expected and the optional component prop too but the typing system just let's any other unknown props go through as well.
- Is this an issue? ListItemText rejects unknown props.
- If it is an issue, any ideas on how to address?
FYI: At the moment, the test_types build on the CI is broken for this reason.
There was a problem hiding this comment.
I don't have the bandwidth to deep-dive into this issue. Maybe some issue with to many free type parameters or some quirk in JSX.
For now just document that this is undesired behavior in code comments. In addition it might be nice to extend these undesired behavior with tests using createElement directly (instead of JSX) and if wrong value types are rejected e.g. { variant: 123213 } or { component: SomeComponentImplementingFooNumber, foo: 'a-string-which-should-be-a-number' }
There was a problem hiding this comment.
- Documented the unmet expectations via comments
- Added createElement tests
- Behaviour is pretty consistent with JSX. Only exception I found was the type system not demanding the required props from the
componentprop type like it does in JSX — both for CardHeader and it's nested typography items. - Wrong value types are indeed rejected (e.g.
{ variant: 123213 }, etc)
- Behaviour is pretty consistent with JSX. Only exception I found was the type system not demanding the required props from the
1 task
oliviertassinari
added
component: card
Add additional tests using React.createElement
eps1lon
approved these changes
Mar 30, 2020
|
@rart Looking good. Thanks! |
EsoterikStare
pushed a commit
to EsoterikStare/material-ui
that referenced
this pull request
Mar 30, 2020
This was referenced Apr 6, 2020
1 task
This was referenced Apr 13, 2020
Closed
1 task
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.
In continuation of #20093