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] Enforce component style rules for Tree View #14963

Merged
merged 5 commits into from
Oct 17, 2024
Merged

[docs] Enforce component style rules for Tree View #14963

merged 5 commits into from
Oct 17, 2024

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Oct 14, 2024 •
edited
Loading

Part of https://www.notion.so/mui-org/Audit-and-edit-MUI-X-docs-10dcbfe7b6608028af52f73cae5b245a

When describing the MUI X product, Tree View (Rich Tree View, Simple Tree View, Tree Item, etc.) components should almost always be capitalized like proper nouns, with a space between each word and no backticks.

When to use component case:

  • When differentiating between similar components that may share some or all of their names in common
    • So "Tree Item components" generally but <TreeItem /> or <TreeItem2 /> specifically
  • When differentiating between Community / Pro / Premium components
    • So "Tree View Pro components" generally but <RichTreeViewPro /> specifically

@samuelsycamore samuelsycamore 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 Oct 14, 2024
@mui-bot
Copy link

mui-bot commented Oct 14, 2024 •
edited
Loading

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

Updated pages:

Generated by 🚫 dangerJS against 8dc36db

@samuelsycamore samuelsycamore marked this pull request as ready for review October 14, 2024 17:42
flaviendelangle
flaviendelangle reviewed Oct 16, 2024
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
samuelsycamore
samuelsycamore commented Oct 16, 2024
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
packages/x-tree-view/src/TreeItem/TreeItem.types.ts Outdated Show resolved Hide resolved
packages/x-tree-view/src/TreeItem2/TreeItem2.types.ts Outdated Show resolved Hide resolved
packages/x-tree-view/src/internals/models/treeView.ts Outdated Show resolved Hide resolved
packages/x-tree-view/src/internals/models/treeView.ts Outdated Show resolved Hide resolved
packages/x-tree-view/src/useTreeItem2/useTreeItem2.types.ts Outdated Show resolved Hide resolved
@samuelsycamore
component case
7b52807 
Signed-off-by: Sycamore <71297412+samuelsycamore@users.noreply.github.com>
flaviendelangle
flaviendelangle approved these changes Oct 17, 2024
View reviewed changes
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.

Looks great 🥳

@samuelsycamore samuelsycamore merged commit 3f1efc3 into mui:master Oct 17, 2024
18 checks passed
@samuelsycamore samuelsycamore mentioned this pull request Oct 23, 2024
Open
This was referenced Nov 8, 2024
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flaviendelangle flaviendelangle flaviendelangle approved these changes

Assignees
No one assigned
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.
3 participants
@samuelsycamore @mui-bot @flaviendelangle