Skip to content
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

[TextField] Improve the API documentation #9514

Merged
merged 1 commit into from Dec 16, 2017

Conversation

oliviertassinari
Copy link
Member

Address api issue of #9326

@oliviertassinari oliviertassinari added component: text field This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation labels Dec 15, 2017
@@ -29,8 +29,10 @@ function TimePickers(props) {
InputLabelProps={{
shrink: true,
}}
inputProps={{
step: 300, // 5 min
InputProps={{
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rosskevin I'm so happy to have the runtime checks back! Flow missed this regression.

@oliviertassinari oliviertassinari self-assigned this Dec 15, 2017
Copy link
Member

@rosskevin rosskevin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking this up, I think it will help a lot of users.

return <TextField id="time" type="time" InputProps={InputProps} />;
```

You will find the following component structure: `TextField` > [`Input`](/api/input) > `input`.
Copy link
Member

@rosskevin rosskevin Dec 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would kill this You will find line. Instead:

For advanced cases, please look at the source of TextField and consider either a) using the upper case props for passing values direct to the components; or b) using the underlying components directly.

Copy link
Member

@rosskevin rosskevin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

accidently approved.

@mui mui deleted a comment from rosskevin Dec 15, 2017
@oliviertassinari oliviertassinari dismissed rosskevin’s stale review December 15, 2017 22:27

It's something I wanted to do since a long time. The recent change was a good occasion :).

@oliviertassinari
Copy link
Member Author

@rosskevin Sorry, I should have done a new commit for reviewing, it was too late before I realized it.

@rosskevin
Copy link
Member

no problem

@oliviertassinari oliviertassinari merged commit e936288 into mui:v1-beta Dec 16, 2017
@oliviertassinari oliviertassinari deleted the docs-textfield-api branch December 16, 2017 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: text field This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants