-
-
Notifications
You must be signed in to change notification settings - Fork 32.7k
[docs] Add more props documentation to IntelliSense #20264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Add more props documentation to IntelliSense #20264
Conversation
Details of bundle changes.Comparing: f46c1e6...dbd1d3e Details of page changes
|
oliviertassinari
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an exciting change :)
This is why it's actually bad to rely on it too much. Goes against one of the strengths of TS: refactoring
|
Need to go over this again just in case. Though I'm quite confident this is fine since our type test coverage is a lot better. |
merceyz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
38645c2 to
9212d46
Compare
| | Name | Type | Default | Description | | ||
| |:-----|:-----|:--------|:------------| | ||
| | <span class="prop-name">anchorEl</span> | <span class="prop-type">object<br>| func</span> | | The DOM element used to set the position of the menu. | | ||
| | <span class="prop-name">anchorEl</span> | <span class="prop-type">func<br>| Element</span> | | The DOM element used to set the position of the menu. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even the markdown docs get an improvement.
| /** | ||
| * @ignore | ||
| */ | ||
| onKeyDown: PropTypes.func, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
onKeyDown and onBlur were unused. Since we spread them to FormGroup the validation still takes place.
|
Yeah 🚀! A small detail that will make a difference. It would be interesting to look at the steps required to roll this approach to 100% of our components. |
|
@oliviertassinari More or less already done locally. Just rolling these out in digestible chunks to |
--patterntoyarn proptypes:yarn proptypes --pattern Buttononly generates proptypes forButtonandButtonBaseExpansionPanelActions,ExpansionPanelDetailsno longer issue proptypes warnings on emtpy children. These components work perfectly well without them.