[docs] Move more prop docs into IntelliSense #20342
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: 69f7046...aa361c0 Details of page changes
|
eps1lon
force-pushed
the
docs/more-proptypes
branch
from
1a09864
to
66083de
Compare
eps1lon
commented
Mar 30, 2020
| @@ -197,7 +201,7 @@ ExpansionPanel.propTypes = { | |||
| */ | |||
| onChange: PropTypes.func, | |||
| /** | |||
| * @ignore | |||
| * If `true`, rounded corners are disabled. | |||
There was a problem hiding this comment.
We could keep ignoring this but I would argue that it's better to document this here since the classes reference it directly ("rounded is applied if square={false}").
eps1lon
commented
Mar 30, 2020
| @@ -27,15 +27,13 @@ You can learn more about the difference by [reading this guide](/guides/minimizi | |||
| | <span class="prop-name">autoComplete</span> | <span class="prop-type">string</span> | | This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it [following the specification](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill). | | |||
| | <span class="prop-name">autoFocus</span> | <span class="prop-type">bool</span> | | If `true`, the `input` element will be focused during the first mount. | | |||
| | <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">className</span> | <span class="prop-type">string</span> | | The CSS class name of the wrapper element. | | |||
There was a problem hiding this comment.
className doesn't add much here. It's forwarded to the root element like any other excess attribute.
eps1lon
force-pushed
the
docs/more-proptypes
branch
from
92fb51e
to
92cbed7
Compare
eps1lon
commented
Apr 2, 2020
| /** | ||
| * @ignore | ||
| */ | ||
| className: PropTypes.string, | ||
| /** | ||
| * A control element. For instance, it can be be a `Radio`, a `Switch` or a `Checkbox`. | ||
| */ | ||
| control: PropTypes.element, | ||
| control: PropTypes.element.isRequired, |
There was a problem hiding this comment.
This was incorrect. We call cloneElement on the value. The TypeScript types were correct
eps1lon
commented
Apr 2, 2020
| @@ -573,7 +578,7 @@ Popover.propTypes = { | |||
| /** | |||
| * Props applied to the [`Paper`](/api/paper/) element. | |||
| */ | |||
| PaperProps: PropTypes.shape({ | |||
| PaperProps: PropTypes /* @typescript-to-proptypes-ignore */.shape({ | |||
There was a problem hiding this comment.
It may be possible to express this at the type level but this would reject our own components (React.ComponentType) that would work at runtime.
github-actions
bot
added
PR: out-of-date
NMinhNguyen
reviewed
Apr 8, 2020
github-actions
bot
removed
the
PR: out-of-date
This was referenced Apr 13, 2020
1 task
1 task
This was referenced Apr 20, 2020
This was referenced May 4, 2020
|
Hey @eps1lon where can I read on why some props (like StepLabel Those were documented in 4.8, and at first glance I can't see any implementation logic that has changed. |
They were typed, but not documented: https://v4-0-2.material-ui.com/api/step-label/#props. Please open a new issue explaining your use case. |
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 a bunch of type fixes that might cause new TypeScript errors:
children. They have no effect.iconandemptyIcontoReact.ReactNode(fromReact.ReactElement)emptyLabelTextundefinedandnullfromchildren. This would cause a runtime errorchildren. They have no effect.renderSuffixrenderPrefix. This would cause a runtime warning. It was likely mistaken forrenderSuffixchildren. They have no effectchildren. They have no effectclassesproptheme. It has no effect.children. They have no effect.children. They have no effect.connecttoReact.ReactElement(fromReact.ReactNode). Arbitrary nodes would cause a crash.The following components need more work. I'll leave them be for now: