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] Add a note about minimal required version for theme merging to the guides #36973

Merged
merged 4 commits into from Apr 27, 2023
Merged

[docs] Add a note about minimal required version for theme merging to the guides #36973

merged 4 commits into from Apr 27, 2023

Conversation

jakub-stastny
Copy link
Contributor

As has been discussed with @siriwatknp here #36664

Basically I have been confused myself by the guides, because the code used in them is VERY recent and since there was no warning, I lost time trying to figure out why is the guide not working for me.

This PR ads the minimal required MUI version to the 2 affected guides, as requested by @siriwatknp.

Signed-off-by: Jakub Šťastný <60524926+jakub-stastny@users.noreply.github.com>
Signed-off-by: Jakub Šťastný <60524926+jakub-stastny@users.noreply.github.com>
@jakub-stastny jakub-stastny marked this pull request as draft April 23, 2023 13:55
@mui-bot
Copy link

mui-bot commented Apr 23, 2023

@jakub-stastny jakub-stastny marked this pull request as ready for review April 23, 2023 13:58
@zannager zannager added package: system Specific to @mui/system package: material-ui Specific to @mui/material package: joy-ui Specific to @mui/joy labels Apr 24, 2023
@danilo-leal danilo-leal changed the title Add a note about minimal required version for theme merging to the guides [docs] Add a note about minimal required version for theme merging to the guides Apr 24, 2023
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Quick copy review as MUI is the company (that produces and maintains Material UI, Joy UI, Base UI, etc) and Material UI is one of its products 😄

@@ -122,6 +122,8 @@ Having more than one styling libraries could introduce unnecessary complexity to

Material UI can coexist with other libraries that depend on emotion or styled-components. To do that, render Material UI's `ThemeProvider` as an inner provider and use the `THEME_ID` to store the theme.

These changes have been added as recently as April 2023, so be sure you're running MUI v5.12.0 or higher.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
These changes have been added as recently as April 2023, so be sure you're running MUI v5.12.0 or higher.
These changes have been added as recently as April 2023, so be sure you're running Material UI v5.12.0 or higher.

Comment on lines 21 to 22
## Making sure you're on the right version of MUI
These changes have been added as recently as April 2023, so be sure you're running MUI v5.12.0 or higher.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Making sure you're on the right version of MUI
These changes have been added as recently as April 2023, so be sure you're running MUI v5.12.0 or higher.
## Making sure you're on the right version of Material UI
These changes have been added as recently as April 2023, so be sure you're running Material UI v5.12.0 or higher.

Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

👍 Thanks for the fix!

@jakub-stastny
Copy link
Contributor Author

No worries @siriwatknp, glad to be of help. I suppose you don't need anything else from me? (I don't understand this GH PR workflow really, so...)

@siriwatknp
Copy link
Member

No worries @siriwatknp, glad to be of help. I suppose you don't need anything else from me? (I don't understand this GH PR workflow really, so...)

Sorry for the confusion. In general, once the PR got approved you don't need to do anything, we will handle the rest. The approved PR usually got merged in the current week or at the beginning of the next week for the release.

@siriwatknp siriwatknp merged commit f4f3164 into mui:master Apr 27, 2023
18 checks passed
binh1298 pushed a commit to binh1298/material-ui that referenced this pull request May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: joy-ui Specific to @mui/joy package: material-ui Specific to @mui/material package: system Specific to @mui/system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants