mui / material-ui

Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.
https://mui.com/material-ui/
MIT License
93.83k stars 32.26k forks source link

[docs] Undocumented `'default'` color #33006

Open emlai opened 2 years ago

emlai commented 2 years ago

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.

mnajdova commented 2 years ago

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.

vctqs1 commented 1 year ago

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 commented 1 year ago

@vctqs1 there should be info around this in https://mui.com/material-ui/migration/v5-component-changes/#%E2%9C%85-remove-default-color-prop

vctqs1 commented 1 year ago

Thank you