mui
[Tree View] Polish the default design & revise the simple version pages
- [x] I have followed (at least) the PR section of the contributing guide.
As the title says! This PR hopefully closes https://github.com/mui/mui-x/issues/11528, and it adds a small coat of polish to the default Tree View look & feel as well as a general revision to the Overview page, applying the latest page structure as described in https://github.com/mui/material-ui/issues/39702. It was a hard one, particularly the disabled section and explaining the ContentProps stuff (which felt too obscure).
https://deploy-preview-11529--material-ui-x.netlify.app/x/react-tree-view/
Deploy preview: https://deploy-preview-11529--material-ui-x.netlify.app/
Updated pages:
- docs/data/tree-view/overview/overview.md
- docs/data/tree-view/rich-tree-view/items/items.md
- docs/data/tree-view/simple-tree-view/customization/customization.md
- docs/data/tree-view/simple-tree-view/expansion/expansion.md
- docs/data/tree-view/simple-tree-view/items/items.md
Generated by :no_entry_sign: dangerJS against 72b1879abb0124b3c92d7a1d4b7bfd86d33c808a
This pull request has conflicts, please resolve those before we can evaluate the pull request.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
It was a hard one, particularly the disabled section and explaining the ContentProps stuff (which felt too obscure).
I'd like to rework this API which is not consistent with the rest of the X components (they are using slots).
I'm getting ready to do a line-by-line review, but from the jump it feels odd to me that this is the "Overview" page for the Tree View. All of the other products use the Overview page pattern to introduce the product and its key features at a high level—closer to marketing than documentation, really. Maybe that pattern isn't as useful in this case since there isn't as much to document, but it feels strange and out of step with the rest of the X docs nonetheless—it throws off my expectations as a reader. I'm not sure what the solution should be. Is there a plan to eventually expand this content into multiple pages? Or will it remain more like a Core-style component demo document?
Is there a plan to eventually expand this content into multiple pages?
The doc has been split into several pages in #11059 which has just been merged I first migrated the doc from the core without modifying it and now we are enriching it and restructuring it :+1:
@samuelsycamore — that makes sense! I merged this PR with master and pulled all the changes from Flavien's PR linked above. For the sake of not exploding this PR's scope even more, I have constrained myself to tackle only the Simple Tree View pages, also because they mostly house the content that was in the all-encompassing Overview page before. :) We can definitely work on revising the Rich-related pages afterward! 🤙
We can definitely work on revising the Rich-related pages afterward!
A lot of it it purely duplicate from SimpleTreeView so it should be an easy follow up :+1:
IMHO the main benefit of the Box is on small demos, it allow to remove the sx prop from the preview
And the TreeView is often close to the max length of the preview, so saving 1-2 lines helps a lot.
But for more complex demos which don't have preview anyway, I do agree they don't bring any value.
This pull request has conflicts, please resolve those before we can evaluate the pull request.
@flaviendelangle I'm assuming your last comment was more about @noraleonte's PR about the Tree View than this one, right? 😅 I just double-checked the changes I'm proposing and didn't find any sx prop added directly to the Tree View! :)
Yes my bad, I commented on her PR yesterday, you can forget that one :+1:
This pull request has conflicts, please resolve those before we can evaluate the pull request.
This pull request has conflicts, please resolve those before we can evaluate the pull request.
This pull request has conflicts, please resolve those before we can evaluate the pull request.
:laughing: Polishing the Tree View doc is an hard task with Git conflict. Respect @danilo-leal :see_no_evil:
The doc structure should be pretty stable now :+1: We are mostly adding new doc sections
This pull request has conflicts, please resolve those before we can evaluate the pull request.
Nice 👍
A likely follow-up: https://github.com/mui/mui-x/issues/11976.
