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] Improve the documentation covering react-router #17343

Merged
merged 4 commits into from
Sep 15, 2019

Conversation

MelMacaluso
Copy link
Contributor

@MelMacaluso MelMacaluso commented Sep 6, 2019

Add example regarding the use of Link from react-router-dom to be used with MenuItem as the documentation was missing this bit and online resources were not easy to find. (neither is deductible, to me at least).

@mui-pr-bot
Copy link

mui-pr-bot commented Sep 6, 2019

No bundle size changes comparing 0ddd56f...44ee082

Generated by 🚫 dangerJS against 44ee082

@eps1lon eps1lon self-assigned this Sep 6, 2019
@oliviertassinari oliviertassinari changed the title Adding the use of Link with MenuItem [docs] Add the use of Link with MenuItem Sep 7, 2019
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Sep 7, 2019
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

We also have a live demo with React Router under https://material-ui.com/components/buttons/#third-party-routing-library

@mbrookes has recently raised the existence of an opportunity to make the button's react-router section easier to understand.

What do you guys think of consolidation this concern under https://material-ui.com/guides/composition/#react-router-demo? We could link the guide from each component page, where appropriate.

@eps1lon
Copy link
Member

eps1lon commented Sep 9, 2019

What do you guys think of consolidation this concern under material-ui.com/guides/composition/#react-router-demo? We could like the guide from each component page, where appropriate.

I like that. Especially since there are plenty of components that are interested in an integration (e.g. generic Links, nav menus, nav treeviews, nav anything basically).

@MelMacaluso
Copy link
Contributor Author

@oliviertassinari I was thinking that too, as MenuItem is not the only use case. Would make much more sense your suggested approach.

@oliviertassinari
Copy link
Member

Is this OK with you guys if I continue this pull request to implement the proposed approach?

@MelMacaluso
Copy link
Contributor Author

Is this OK with you guys if I continue this pull request to implement the proposed approach?

It would be ideal for me as I didn't find time in-between work and personal life, you're a star 🌟

Add example regarding the use of Link from react-router-dom to be used with MenuItem as the documentation was missing this bit and online resources were not easy to find. (neither is deductible, to me at least).
@oliviertassinari oliviertassinari changed the title [docs] Add the use of Link with MenuItem [docs] Improve the documentation covering react-router Sep 14, 2019
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.

The day react-router adds hooks we can drop another use case for the component prop. This will look so much friendlier.

@oliviertassinari
Copy link
Member

@MelMacaluso Thank you!

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants