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] Uplift SimpleTreeView customization examples #11424

Merged
merged 20 commits into from
Jan 16, 2024

Conversation

noraleonte
Copy link
Contributor

@noraleonte noraleonte commented Dec 15, 2023

Changes:

  • Cleaned up existing Custom icons, borders and animation demo -> split into more modular demos, highlighting each customization and gradually building up a more complex customized Tree View
  • Added new demo
  • Adjusted gmail clone demo (dark mode especially)

Preview:

https://deploy-preview-11424--material-ui-x.netlify.app/x/react-tree-view/simple-tree-view/customization/

@noraleonte noraleonte added docs Improvements or additions to the documentation component: tree view TreeView, TreeItem. This is the name of the generic UI component, not the React module! labels Dec 15, 2023
@noraleonte noraleonte self-assigned this Dec 15, 2023
@mui-bot
Copy link

mui-bot commented Dec 15, 2023

@noraleonte noraleonte marked this pull request as ready for review December 21, 2023 14:40
@flaviendelangle
Copy link
Member

flaviendelangle commented Dec 21, 2023

That's a big improvement over the current doc 👌

I liked a lot the "Adding borders" demo which is probably a very common use case

I'm not a fan of the "Customizing for complex use cases" demo because it's a demo that display the power of our component when the others focus on a specific use-case.
Same for the Gmail clone.
I like a lot the idea to try to build some very appealing Tree View to show that it can be done with our component, but I would separate them for the more API focused demos (that would always use the same data set and focus only on a specific change like the border or the animation).
And probably always name them from the UI we are implementing (a mail client, a file explorer etc...) instead of "rich" or "complex' or "advanced" which do not bring a lot of value IMHO

Copy link
Contributor

@danilo-leal danilo-leal 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 looking great, Nora — nice work! 👏 Just left a few notes about writing & the designs.

docs/data/tree-view/overview/overview.md Outdated Show resolved Hide resolved
docs/data/tree-view/overview/overview.md Outdated Show resolved Hide resolved
docs/data/tree-view/overview/overview.md Outdated Show resolved Hide resolved
docs/data/tree-view/overview/overview.md Outdated Show resolved Hide resolved
docs/data/tree-view/overview/overview.md Outdated Show resolved Hide resolved
docs/data/tree-view/overview/overview.md Outdated Show resolved Hide resolved
docs/data/tree-view/overview/CustomizedTreeView.tsx Outdated Show resolved Hide resolved
docs/data/tree-view/overview/CustomizedTreeView.tsx Outdated Show resolved Hide resolved
docs/data/tree-view/overview/CustomMaterialIcons.tsx Outdated Show resolved Hide resolved
docs/data/tree-view/overview/CustomIcons.js Outdated Show resolved Hide resolved
@danilo-leal danilo-leal added the design This is about UI or UX design, please involve a designer label Dec 21, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 2, 2024
Copy link

github-actions bot commented Jan 2, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@zanivan
Copy link
Contributor

zanivan commented Jan 8, 2024

Hey, nice work @noraleonte!

Echoing Flavien, I think the demos, though look nice, could be better placed or organized. I wonder if we could add an item such as "Customization" or "Styling" to the menu instead adding these demos to Overview, where we can populate it with demos and a playground in the future, like the styling page from Charts.
Other example is how we do on Joy UI to showcase these complex demos, by the common examples section in the end of the page.

@flaviendelangle
Copy link
Member

I wonder if we could add an item such as "Customization" or "Styling" to the menu instead adding these demos to Overview

This will be the case once the PR is merged with next

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 9, 2024
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Looking awesome, Nora — thanks for bearing with us on the review!
Just a round of fine-tune stuff :)

Co-authored-by: Danilo Leal <[email protected]>
Signed-off-by: Nora <[email protected]>
@flaviendelangle flaviendelangle changed the title [docs] Uplift TreeView customization examples [docs] Uplift SimpleTreeView customization examples Jan 15, 2024
Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

Awesome improvements of the doc!

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Just a last round of touch-ups, but already dropping an approval! :)
Great work, Nora—thanks for pushing through!

@noraleonte noraleonte merged commit 0c8c938 into mui:next Jan 16, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: tree view TreeView, TreeItem. This is the name of the generic UI component, not the React module! design This is about UI or UX design, please involve a designer docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants