[system] Warn when calling setMode without configuring colorSchemeSelector
#43783
+45
−3
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
package: system
siriwatknp
changed the title
setMode without configuring colorSchemeSelector
Netlify deploy previewhttps://deploy-preview-43783--material-ui.netlify.app/ Bundle size reportDetails of bundle changes (Toolpad) |
Comment on lines
+251
to
+252
| 'MUI: The `setMode` function has no effect if `colorSchemeSelector` is not configured.', | ||
| 'To toggle the mode manually, please configure `colorSchemeSelector` to use a class or data attribute.', |
There was a problem hiding this comment.
"is not configured" might be confusing, because one can explicitly set colorSchemeSelector: 'media' in the theme. Maybe we can reword it:
Suggested change
| 'MUI: The `setMode` function has no effect if `colorSchemeSelector` is not configured.', | |
| 'To toggle the mode manually, please configure `colorSchemeSelector` to use a class or data attribute.', | |
| 'MUI: The `setMode` function has no effect if `colorSchemeSelector` is `media` (`media` is the default value).', | |
| 'To toggle the mode manually, please configure `colorSchemeSelector` to use a class or data attribute.', |
| @@ -360,4 +367,24 @@ describe('[Material UI] ThemeProviderWithVars', () => { | |||
| borderBottomRightRadius: '16px', | |||
| }); | |||
| }); | |||
|
|
|||
| it('show warning when using `setMode` without configuring `colorSchemeSelector`', () => { | |||
There was a problem hiding this comment.
Not sure if it's worth it, but we could also test when explicitly setting colorSchemeSelector: 'media'.
| @@ -360,4 +367,24 @@ describe('[Material UI] ThemeProviderWithVars', () => { | |||
| borderBottomRightRadius: '16px', | |||
| }); | |||
| }); | |||
|
|
|||
| it('show warning when using `setMode` without configuring `colorSchemeSelector`', () => { | |||
There was a problem hiding this comment.
Suggested change
| it('show warning when using `setMode` without configuring `colorSchemeSelector`', () => { | |
| it('warns when using `setMode` without configuring `colorSchemeSelector`', () => { |
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.
From #43533 (comment)
Currently with CSS theme variables enabled, calling
setModehas no effect ifcolorSchemeSelectoris not configured. Technically, this is correct because the default method is@media (prefers-color-scheme), so user cannot toggle mode manually.However, from the DX perspective, it's confusion of why it does not work. This PR added a warning if calling
setModewithout configuringcolorSchemeSelector.