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] Document that @material-ui/styles is not strict mode compatible #27639

Merged
merged 3 commits into from
Aug 12, 2021

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Aug 7, 2021

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/

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation package: styles Specific to @mui/styles. Legacy package, @material-ui/styled-engine is taking over in v5. labels Aug 7, 2021
@oliviertassinari oliviertassinari force-pushed the docs-strict-mode-styles branch from 7f3c5a9 to c9e762b Compare August 7, 2021 22:01
@mui-pr-bot
Copy link

mui-pr-bot commented Aug 7, 2021

No bundle size changes (experimental)

Generated by 🚫 dangerJS against 4112072

Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

Great 👌

@eps1lon eps1lon changed the title [docs] Document that @material-ui/styles is not strict mode friendly [docs] Document that @material-ui/styles is not strict mode compatible Aug 9, 2021
Copy link
Member

@eps1lon eps1lon left a 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.

docs/src/pages/styles/basics/basics.md Outdated Show resolved Hide resolved
> ⚠️ `@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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> 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.

Copy link
Member Author

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

Capture d’écran 2021-08-09 à 23 58 00

https://emotion.sh/docs/css-prop

Capture d’écran 2021-08-09 à 23 59 14

Copy link
Contributor

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.

Copy link
Contributor

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

docs/src/pages/styles/basics/basics.md Outdated Show resolved Hide resolved
oliviertassinari and others added 2 commits August 9, 2021 23:53
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
Copy link
Member

@eps1lon eps1lon left a 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"

@oliviertassinari
Copy link
Member Author

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.

@oliviertassinari oliviertassinari merged commit 668c7be into mui:next Aug 12, 2021
@oliviertassinari oliviertassinari deleted the docs-strict-mode-styles branch August 12, 2021 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: styles Specific to @mui/styles. Legacy package, @material-ui/styled-engine is taking over in v5.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants