[system] Warn when calling setMode without configuring colorSchemeSelector
#43783
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) |
siriwatknp
force-pushed
the
warn/use-color-scheme
branch
from
d9378b9
to
3bf744e
Compare
…l-ui into warn/use-color-scheme
|
@aarongarciah Sorry for the delay, I applied your suggesion. Could you do another review? |
mnajdova
approved these changes
Nov 11, 2024
aarongarciah
approved these changes
Nov 11, 2024
| [ | ||
| '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.', | ||
| 'To learn more, visit https://mui.com/material-ui/customization/css-theme-variables/configuration/#toggling-dark-mode-manually', |
There was a problem hiding this comment.
How about we enforce all of those links to be permalink? mui/mui-public#222
Suggested change
| 'To learn more, visit https://mui.com/material-ui/customization/css-theme-variables/configuration/#toggling-dark-mode-manually', | |
| 'To learn more, visit https://mui.com/r/set-mode-media', | |
Especially a hash link, it seems too brittle.
| if (theme.colorSchemeSelector === 'media') { | ||
| console.error( | ||
| [ | ||
| 'MUI: The `setMode` function has no effect if `colorSchemeSelector` is `media` (`media` is the default value).', |
There was a problem hiding this comment.
- () To match with how we reference functions in the docs?
- if -> when. If could create doubt about either this is true or not in the case the warning triggers?
Suggested change
| 'MUI: The `setMode` function has no effect if `colorSchemeSelector` is `media` (`media` is the default value).', | |
| 'MUI: The `setMode()` function has no effect when `colorSchemeSelector` is `media` (`media` is the default value).', |
Rule of error messages: https://www.notion.so/mui-org/Technical-writing-guidance-7e55b517ac2e489a9ddb6d0f6dd765de?pvs=4#85219822c3194b6f8a49ee08ea82b90a.
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.