-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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] Document that @material-ui/styles is not strict mode compatible #27639
[docs] Document that @material-ui/styles is not strict mode compatible #27639
Conversation
7f3c5a9
to
c9e762b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great 👌
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will close #13394 manually.
> ⚠️ `@material-ui/styles` is the legacy styling solution for Material-UI. | ||
> It's **deprecated** in v5, which is not used by the other packages anymore. | ||
> It depends on [JSS](https://cssinjs.org/). | ||
> If you don't want to have both emotion & JSS in your bundle, please refer to the [`@material-ui/system`](/system/basics/) documentation which is the recommended alternative. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> If you don't want to have both emotion & JSS in your bundle, please refer to the [`@material-ui/system`](/system/basics/) documentation which is the recommended alternative. | |
> If you don't want to have both Emotion & JSS in your bundle, please refer to the [`@material-ui/system`](/system/basics/) documentation which is the recommended alternative. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Andarist how would you wish https://github.com/emotion-js/emotion to be referenced in the documentation of Material-UI?
We have used "emotion" so far, but maybe we shouldn't have. For instance, https://emotion.sh/docs/introduction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think Emotion is fine - it makes it more obvious that it's the name of something (like a library). I probably should unify this across the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gonna confirm with other maintainers to see what they prefer since they were choosing the name in the past ;p
Co-authored-by: Sebastian Silbermann <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I do believe we should "Emotion" over "emotion" since "emotion" is not indicating that it is used as a proper name not the "emotion" as in "feeling"
@eps1lon possibly, I don't have a preference. I'm keeping "emotion" to match the current standard we use in the documentation. If we want to change it, it can be a dedicated PR. I would personally wait for direction from the maintainers of the project. |
Act on #13394 (comment). I have also used the opportunity to push the legacy notice further than what we did so far for
@material-ui/styles
.Preview: https://deploy-preview-27639--material-ui.netlify.app/styles/basics/