[docs] Move more prop docs into IntelliSense #20298
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
Details of bundle changes.Comparing: c16f941...13bef15 Details of page changes
|
With or without the unmerged PRs? |
This PR only requires merceyz/typescript-to-proptypes#7 |
|
Released, i'll take a look at your PRs this weekend |
eps1lon
commented
Mar 27, 2020
| @@ -279,12 +283,12 @@ Dialog.propTypes = { | |||
| /** | |||
| * Dialog children, usually the included sub-components. | |||
| */ | |||
| children: PropTypes.node.isRequired, | |||
| children: PropTypes.node, | |||
There was a problem hiding this comment.
Not sure what the point is making a node required. One could still omit content by passing false. TypeScript allowed undefined | null since the beginning.
There was a problem hiding this comment.
It was meant to tell users that instead of
<Dialog>{condition ? <B /> : null}</Dialog>they might prefer
{condition ? <Dialog><B /></Dialog> : null}But no strong preference
There was a problem hiding this comment.
<Dialog>{condition ? <B /> : null}</Dialog>
This is how I prefer to write conditional rendering as well but I see very many people defaulting to shorthand <Dialog>{condition && <B />}</Dialog> which does pass PropTypes.node.isRequired
I wouldn't mind adding a warning with a rationale why one pattern should be preferred but then it needs a rationale, an actionable hint and needs to be applied consistently.
eps1lon
commented
Mar 27, 2020
| disabled?: boolean; | ||
| IconComponent?: React.ElementType; | ||
| inputRef?: ( | ||
| ref: HTMLSelectElement | { node: HTMLInputElement; value: NativeSelectInputProps['value'] }, |
There was a problem hiding this comment.
Could not find how this is implemented.
eps1lon
commented
Mar 27, 2020
| @@ -26,16 +26,21 @@ export const styles = { | |||
| const Step = React.forwardRef(function Step(props, ref) { | |||
| const { | |||
| active = false, | |||
| // eslint-disable-next-line react/prop-types | |||
There was a problem hiding this comment.
private props are rare enough so that we don't need to handle them. If missing validation becomes an issue when debugging we can revisit. But these components haven't been touched in a long time.
oliviertassinari
approved these changes
Mar 27, 2020
| @@ -279,12 +283,12 @@ Dialog.propTypes = { | |||
| /** | |||
| * Dialog children, usually the included sub-components. | |||
| */ | |||
| children: PropTypes.node.isRequired, | |||
| children: PropTypes.node, | |||
There was a problem hiding this comment.
It was meant to tell users that instead of
<Dialog>{condition ? <B /> : null}</Dialog>they might prefer
{condition ? <Dialog><B /></Dialog> : null}But no strong preference
EsoterikStare
pushed a commit
to EsoterikStare/material-ui
that referenced
this pull request
Mar 30, 2020
This was referenced Mar 30, 2020
This was referenced Apr 7, 2020
Merged
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.
Includes the following fixes to TypeScript types:
NativeSelectinputonly allowsReactElementsnot just anyReactNodeNativeSelectinputPropsnow allows all<select>attributesBlocked until new release of typescript-to-proptypes