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

[docs] Add generic props usage examples #19341

Merged
merged 12 commits into from
Feb 3, 2020
Merged

[docs] Add generic props usage examples #19341

merged 12 commits into from
Feb 3, 2020

Conversation

fyodore82
Copy link
Contributor

@fyodore82 fyodore82 commented Jan 22, 2020

Related #18868

@mui-pr-bot
Copy link

mui-pr-bot commented Jan 22, 2020

No bundle size changes comparing 4a96d14...efd690c

Generated by 🚫 dangerJS against efd690c

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation typescript labels Jan 22, 2020
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

This is great stuff. Do you think you write it so that it applies to other components as well? I would like to move this to our typescript guide instead. As far as I can tell any component that implements the component prop has a props interface with these capabilities.

docs/src/pages/components/typography/typography.md Outdated Show resolved Hide resolved
@fyodore82
Copy link
Contributor Author

Yes, any component based on OverrideProps can be used this way.
I'll move this section to Typescript guid. And add references to components that can be used the same way.

@oliviertassinari oliviertassinari added the PR: needs revision The pull request can't be merged. More details is available on the code review or fails in the CI label Jan 26, 2020
@fyodore82
Copy link
Contributor Author

@eps1lon , please take a look. I've moved the section to Typescript Guide. And noted that any component which has props based on OverrideProps can be used this way.

@oliviertassinari oliviertassinari removed the PR: needs revision The pull request can't be merged. More details is available on the code review or fails in the CI label Jan 27, 2020
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

Looking great so far. Just a minor nitpick.

docs/src/pages/guides/typescript/typescript.md Outdated Show resolved Hide resolved
@oliviertassinari oliviertassinari added the PR: needs revision The pull request can't be merged. More details is available on the code review or fails in the CI label Feb 1, 2020
@fyodore82 fyodore82 closed this Feb 3, 2020
@fyodore82 fyodore82 reopened this Feb 3, 2020
@eps1lon eps1lon removed the PR: needs revision The pull request can't be merged. More details is available on the code review or fails in the CI label Feb 3, 2020
@eps1lon eps1lon changed the title [docs] Add TypographyProps usage examples [docs] Add generic props usage examples Feb 3, 2020
@eps1lon eps1lon merged commit 5d1bab6 into mui:master Feb 3, 2020
@eps1lon
Copy link
Member

eps1lon commented Feb 3, 2020

@fyodore82 Very nice, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants