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

[material-ui][Tabs] Improve TabContext, TabList, and TabPanel documentation #40558

Closed
DiegoAndai opened this issue Jan 12, 2024 · 2 comments · Fixed by #40587
Closed

[material-ui][Tabs] Improve TabContext, TabList, and TabPanel documentation #40558

DiegoAndai opened this issue Jan 12, 2024 · 2 comments · Fixed by #40587
Assignees
Labels
component: tabs This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation

Comments

@DiegoAndai
Copy link
Member

DiegoAndai commented Jan 12, 2024

The TabContext, TabList, and TabPanel are "mentioned" on the Tab docs in a single demo. These components could use more explanation.

It's also weird that it's so high up on the docs page but have no further explanation and are not mentioned again, this can be very confusing for users.

Issue comes from docs-feedback

@DiegoAndai DiegoAndai added docs Improvements or additions to the documentation component: tabs This is the name of the generic UI component, not the React module! labels Jan 12, 2024
@DiegoAndai
Copy link
Member Author

@samuelsycamore where are we storing docs-improvement issues?

@DiegoAndai DiegoAndai changed the title [material-ui][Tabs] Improbe TabContext, TabList, and TabPanel documentation [material-ui][Tabs] Improve TabContext, TabList, and TabPanel documentation Jan 12, 2024
@samuelsycamore
Copy link
Member

samuelsycamore commented Jan 12, 2024

We've got this umbrella issue to track the progress of adding more details about what I'm calling "complementary" components: #39952 - @anle9650 made a nice list for us that includes the Tabs components. 🙏

I think we can follow the same pattern established in the Base UI docs: https://mui.com/base-ui/react-tabs/ - I like using <ComponentCase /> to differentiate between these Tab components because the names are so similar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: tabs This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants