[CssVarsProvider] Always generate new css object
#36853
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
siriwatknp
added
bug 🐛
Netlify deploy previewhttps://deploy-preview-36853--material-ui.netlify.app/ Bundle size report |
siriwatknp
commented
Apr 12, 2023
| @@ -38,9 +38,12 @@ function prepareCssVars<T extends DefaultCssVarsTheme, ThemeVars extends Record< | |||
|
|
|||
| const generateCssVars = (colorScheme?: string) => { | |||
| if (!colorScheme) { | |||
| return { css: rootCss, vars: rootVars }; | |||
| return { css: { ...rootCss }, vars: rootVars }; | |||
There was a problem hiding this comment.
the vars can stay the same because we don't alter them anywhere.
mnajdova
approved these changes
Apr 12, 2023
siriwatknp
commented
Apr 12, 2023
Comment on lines
+9
to
+14
| const [, rerender] = React.useState(false); | ||
| React.useEffect(() => { | ||
| // Trigger rerender to ensure that the UI does not change after the first render. | ||
| // To catch bug like https://github.com/mui/material-ui/issues/36452 | ||
| rerender(true); | ||
| }, []); |
There was a problem hiding this comment.
@mnajdova There is a flaw in this visual regression. It produces the correct snapshot if the component renders just once which happens in the visual regression test.
Added the rerender(true) to trigger the second render. This should cover the bug the this PR solves.
There was a problem hiding this comment.
Perfect, thanks for looking into this. Alright, let's merge.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #36452
Root cause
There is a logic in
createCssVarsProviderthat will delete some fields from thecssobject to not be included in the:root. Since thecssis not always a new object, all of the--mui-overlays-*are removed in the first render and never exist after that.Fix
just need to ensure that the
cssis always a new object.✅ Test added.