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][material] Rename custom tab panel in Tabs demo to prevent confusion with @mui/lab #37638

Merged
merged 7 commits into from
Jul 2, 2023

Conversation

MUK-Dev
Copy link
Contributor

@MUK-Dev MUK-Dev commented Jun 18, 2023

This PR fixes #35466

On the Tabs docs page first example. A custom TabPanel was being declared and it used the same name as the TabPanel in @mui/lab. So I renamed the TabPanel in the local scope to CustomTabPanel to avoid confusion and wrong auto imports.

@mui-bot
Copy link

mui-bot commented Jun 18, 2023

Netlify deploy preview

https://deploy-preview-37638--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 8f9af44

@MUK-Dev
Copy link
Contributor Author

MUK-Dev commented Jun 18, 2023

I ran all the tests mentioned in the contributing file. ✔️

Running yarn docs:api adds this line

import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';

in

/docs/pages/base-ui/react-all-components/[docsTab]/index.js

but mapApiPageTranslations is not used in the file so it generates eslint error.

@zannager zannager added the component: tabs This is the name of the generic UI component, not the React module! label Jun 19, 2023
@zannager zannager requested a review from mnajdova June 19, 2023 09:21
@danilo-leal danilo-leal changed the title Tab docs example fix [docs][material] Fix Basic tabs demo Jun 19, 2023
@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Jun 19, 2023
@samuelsycamore samuelsycamore changed the title [docs][material] Fix Basic tabs demo [docs][material] Rename Tab Panel in demo to prevent confusion with @mui/lab Jul 2, 2023
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Thanks for this @MUK-Dev ! I'm not sure where those two extra files were coming from, but they don't exist on the master branch so I removed them and that solved the problem. :)

@samuelsycamore samuelsycamore changed the title [docs][material] Rename Tab Panel in demo to prevent confusion with @mui/lab [docs][material] Rename custom tab panel in Tabs demo to prevent confusion with @mui/lab Jul 2, 2023
@samuelsycamore samuelsycamore merged commit 9fe770e into mui:master Jul 2, 2023
18 checks passed
@MUK-Dev
Copy link
Contributor Author

MUK-Dev commented Jul 2, 2023

Ok, thanks

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 package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] documentation for tabs is either out of date, or the tabs themselves are bugged
5 participants