[docs] Move more prop docs into IntelliSense #21368
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
eps1lon
commented
Jun 8, 2020
| * This prop isn't supported. | ||
| * Use the `component` prop if you need to change the children structure. | ||
| */ | ||
| children?: null; |
There was a problem hiding this comment.
Suggested change
| children?: null; | |
| children?: never; |
would've been better but throws during yarn proptypes because there's no sensible proptype for it. This works and can be merged. We can improve later.
eps1lon
commented
Jun 8, 2020
| @@ -30,7 +30,7 @@ The `MuiCardMedia` name can be used for providing [default props](/customization | |||
| |:-----|:-----|:--------|:------------| | |||
| | <span class="prop-name">children</span> | <span class="prop-type">node</span> | | The content of the component. | | |||
| | <span class="prop-name">classes</span> | <span class="prop-type">object</span> | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. | | |||
| | <span class="prop-name">component</span> | <span class="prop-type">elementType</span> | <span class="prop-default">'div'</span> | Component for rendering image. Either a string to use a HTML element or a component. | | |||
| | <span class="prop-name">component</span> | <span class="prop-type">elementType</span> | <span class="prop-default">'div'</span> | The component used for the root node. Either a string to use a HTML element or a component. | | |||
There was a problem hiding this comment.
Unfortunate but the prop documentation is only useful if you don't know for what component it is. We'll see if up-to-date ts/prop types are worth more than this documentation.
Details of bundle changes.Comparing: 4e21a1d...f1c9cd1 Details of page changes
|
joshwooding
approved these changes
Jun 8, 2020
curtislin7
pushed a commit
to curtislin7/material-ui
that referenced
this pull request
Jun 10, 2020
vhenzl
reviewed
Jun 19, 2020
| @@ -3,8 +3,23 @@ import { OverridableComponent, OverrideProps } from '../OverridableComponent'; | |||
|
|
|||
| export interface ContainerTypeMap<P = {}, D extends React.ElementType = 'div'> { | |||
| props: P & { | |||
| children: NonNullable<React.ReactNode>; | |||
There was a problem hiding this comment.
Unfortunately, this is a breaking change. null and undefined were previously allowed as children but updating to v4.10.2 breaks code that relies on implicit React.ReactNode type.
There was a problem hiding this comment.
These always logged runtime, dev-only warnings. Though we're considering revisiting required children for v5.
There was a problem hiding this comment.
Aha, OK, I've never noticed that warning… Not sure though that the restriction makes sense; it should disallow false as well and even then it wouldn't prevent rendering Container without content as an empty string, which is effectively the same, could still be passed.
There was a problem hiding this comment.
Sure, but just because a solution isn't perfect doesn't mean we shouldn't try to. The idea was to report the most common mistakes. You can always silence TS by passing <Container>{children!}</Container>.
2 tasks
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.
core components starting with
C