Skip to content

[docs] Undocumented 'default' color #33006

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

Open
emlai opened this issue Jun 3, 2022 · 4 comments
Open

[docs] Undocumented 'default' color #33006

emlai opened this issue Jun 3, 2022 · 4 comments
Assignees
Labels

Comments

@emlai
Copy link
Contributor

emlai commented Jun 3, 2022

Some components (at least IconButton and Chip) mention 'default' as the default color:
Screen Shot 2022-06-03 at 15 30 14

But the meaning of this color value is not explained anywhere in the docs. The other color values are explained in the palette documentation.

@emlai emlai changed the title [IconButton] 'default' color is not explained [IconButton] Undocumented default color value Jun 3, 2022
@emlai emlai changed the title [IconButton] Undocumented default color value [IconButton] Undocumented default color Jun 3, 2022
@emlai emlai changed the title [IconButton] Undocumented default color [IconButton] Undocumented 'default' color Jun 6, 2022
@emlai emlai changed the title [IconButton] Undocumented 'default' color [docs] Undocumented 'default' color Jun 6, 2022
@michaldudak michaldudak added package: material-ui Specific to @mui/material status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Oct 11, 2022
@michaldudak michaldudak added the docs Improvements or additions to the documentation label Oct 11, 2022
@mnajdova
Copy link
Member

mnajdova commented Oct 26, 2022

Thanks for pointing this out. In v5 we had an effort for removing all default values for the color prop, but in these components it seems like there is some kind of default color that is different than the rest. In my opinion we should rename it to something more descriptive, for example in the IconButton it seems to be none or transparent. I am adding the issue for the v6 milestone, as renaming the prop would be a braking change.

@mnajdova mnajdova added breaking change v6.x and removed docs Improvements or additions to the documentation status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Oct 26, 2022
@mnajdova mnajdova added this to the v6 milestone Oct 26, 2022
@vctqs1
Copy link

vctqs1 commented Dec 12, 2022

Thanks for pointing this out. In v5 we had an effort for removing all default values for the color prop, but in these components it seems like there is some kind of default color that is different than he rest. In my opinion we should rename it to something more descriptive, for example in the IconButton it seems to be none or transparent. I am adding the issue for the v6 milestone, as renaming the prop would be a braking change.

I get issue when upgrade theme from MUI v4 to v5, do you have any docs related to remove default value in color props

@mnajdova
Copy link
Member

@vctqs1
Copy link

vctqs1 commented Dec 20, 2022

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

6 participants