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.

Sign up for GitHub

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

Jump to bottom

[docs] Unify Tree View apiRef methods doc examples #13193

Merged
merged 8 commits into from
May 21, 2024
Merged

[docs] Unify Tree View apiRef methods doc examples #13193

merged 8 commits into from
May 21, 2024

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented May 21, 2024 •
edited
Loading

  • Document the apiRef.getItem method on the Items page of RichTreeView (for SimpleTreeView it only returns the id and label, I don't think it's worth documenting but I can do it if you want)
  • Add the :::success callout on each apiRef doc section to show how to initialize it
  • Move every apiRef method presentation under a Imperative API section (name to be discussed)
  • Rename every apiRef method demo to be ApiMethod{NameOfTheMethod}
  • Add a code snippet showing how to use each apiRef method and describing its parameters

@flaviendelangle flaviendelangle 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 May 21, 2024
@flaviendelangle flaviendelangle self-assigned this May 21, 2024
@mui-bot
Copy link

mui-bot commented May 21, 2024 •
edited
Loading

Deploy preview: https://deploy-preview-13193--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against f325b2a

@flaviendelangle flaviendelangle changed the title [docs] Unify Tree View apiRef methods doc examples [docs] Unify Tree View apiRef methods doc examples May 21, 2024
@flaviendelangle flaviendelangle marked this pull request as ready for review May 21, 2024 09:17
michelengelen
michelengelen reviewed May 21, 2024
View reviewed changes
Copy link
Member

@michelengelen michelengelen left a comment

Choose a reason for hiding this comment

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

A few small things. Looking solid overall! 👍🏼 Nice work!

docs/data/tree-view/rich-tree-view/expansion/expansion.md Outdated Show resolved Hide resolved
docs/data/tree-view/rich-tree-view/focus/focus.md Outdated Show resolved Hide resolved
docs/data/tree-view/rich-tree-view/focus/focus.md Outdated Show resolved Hide resolved
docs/data/tree-view/rich-tree-view/items/items.md Outdated Show resolved Hide resolved
docs/data/tree-view/simple-tree-view/expansion/expansion.md Outdated Show resolved Hide resolved
docs/data/tree-view/simple-tree-view/focus/focus.md Outdated Show resolved Hide resolved
flaviendelangle and others added 5 commits May 21, 2024 11:26
@flaviendelangle @michelengelen
Update docs/data/tree-view/rich-tree-view/focus/focus.md
b8d25cf 
Co-authored-by: Michel Engelen <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle @michelengelen
Update docs/data/tree-view/rich-tree-view/focus/focus.md
a4dbe47 
Co-authored-by: Michel Engelen <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle @michelengelen
Update docs/data/tree-view/rich-tree-view/items/items.md
3541890 
Co-authored-by: Michel Engelen <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle @michelengelen
Update docs/data/tree-view/simple-tree-view/focus/focus.md
309a4e8 
Co-authored-by: Michel Engelen <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle
Fix
f5c65f0
noraleonte
noraleonte approved these changes May 21, 2024
View reviewed changes
Copy link
Contributor

@noraleonte noraleonte left a comment

Choose a reason for hiding this comment

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

Very nice improvement 🎉

@flaviendelangle flaviendelangle merged commit 11decfc into mui:master May 21, 2024
17 checks passed
@flaviendelangle flaviendelangle deleted the apiRef-doc-examples branch May 21, 2024 13:08
arthurbalduini pushed a commit to arthurbalduini/mui-x that referenced this pull request May 23, 2024
@flaviendelangle @michelengelen
[docs] Unify Tree View apiRef methods doc examples (mui#13193)
4cf49db 
Signed-off-by: Flavien DELANGLE <[email protected]>
Co-authored-by: Michel Engelen <[email protected]>
@Rossen27 Rossen27 mentioned this pull request Jun 22, 2024
Open
DungTiger pushed a commit to DungTiger/mui-x that referenced this pull request Jul 23, 2024
@flaviendelangle @michelengelen @DungTiger
[docs] Unify Tree View apiRef methods doc examples (mui#13193)
7246610 
Signed-off-by: Flavien DELANGLE <[email protected]>
Co-authored-by: Michel Engelen <[email protected]>
thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024
@flaviendelangle @michelengelen @thomasmoon
[docs] Unify Tree View apiRef methods doc examples (mui#13193)
3c3f226 
Signed-off-by: Flavien DELANGLE <[email protected]>
Co-authored-by: Michel Engelen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michelengelen michelengelen michelengelen left review comments

@noraleonte noraleonte noraleonte approved these changes

Assignees

@flaviendelangle flaviendelangle

Labels
component: tree view TreeView, TreeItem. This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@flaviendelangle @mui-bot @michelengelen @noraleonte