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][docs] Document Typography color prop breaking change #43735

Merged

Conversation

aarongarciah
Copy link
Member

@aarongarciah aarongarciah commented Sep 12, 2024

Resolves #43589

We documented the deprecation of system props in the v6 upgrade guide: https://mui.com/material-ui/migration/migrating-from-deprecated-apis/#system-props. But we introduced a breaking change in the color prop of the Typography component: it's not a system prop anymore, and thus it doesn't support callbacks to access the theme, responsive values, etc.

This PR documents the breaking change.

@aarongarciah aarongarciah added docs Improvements or additions to the documentation component: Typography The React component. package: material-ui Specific to @mui/material labels Sep 12, 2024
@aarongarciah aarongarciah self-assigned this Sep 12, 2024
@aarongarciah aarongarciah marked this pull request as ready for review September 12, 2024 17:43
@@ -360,6 +360,25 @@ As the `ListItem` no longer supports these props, the class names related to the

In v6, the `children` prop passed to the Loading Button component is now wrapped in a `<span>` tag to avoid [issues](https://github.com/mui/material-ui/issues/27853) when using tools to translate websites.

### Typography
Copy link
Member Author

Choose a reason for hiding this comment

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

I decided to add a new entry since this is an undocumented breaking change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: Typography The React component. 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.

[Typography] types cannot be a callback for color prop
3 participants