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.

Sign up for GitHub

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

Jump to bottom

[system] Add defaultMode to InitColorSchemeScript #44139

Merged
merged 2 commits into from
Oct 21, 2024
Merged

[system] Add defaultMode to InitColorSchemeScript #44139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42ad012
add defaultMode to InitColorSchemeScript
siriwatknp Oct 17, 2024
ab80c08
update docs
siriwatknp Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/data/material/customization/dark-mode/dark-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,14 @@ To set a different default mode, pass the `defaultMode` prop to the ThemeProvide
The `defaultMode` value can be `'light'`, `'dark'`, or `'system'`.
:::

### InitColorSchemeScript component
Copy link
Member

@oliviertassinari oliviertassinari Oct 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Should we inverse the docs order? It looks like if <InitColorSchemeScript defaultMode="dark"> is used, <ThemeProvider defaultMode="dark"> is a no-op.

It would make sense to document this as well?

Now, developers need to set both because the initial load might not have InitColorSchemeScript or System based components while the next page has. If all pages have InitColorSchemeScript, then I guess it's a 100% no-op.

Actually, It seems that the whole page is wrong. This is MUI System docs no? so it shouldn't be documented in Material UI.

We are also missing the API table page for InitColorSchemeScript.


If you are using the `InitColorSchemeScript` component to [prevent SSR flicker](/material-ui/customization/css-theme-variables/configuration/#preventing-ssr-flickering), you have to set the `defaultMode` with the same value you passed to the `ThemeProvider` component:

```js
<InitColorSchemeScript defaultMode="dark">
```

## Styling in dark mode

Use the `theme.applyStyles` utility to apply styles for a specific mode.
Expand Down
8 changes: 7 additions & 1 deletion packages/mui-system/src/InitColorSchemeScript/InitColorSchemeScript.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ export const DEFAULT_COLOR_SCHEME_STORAGE_KEY = 'color-scheme';
export const DEFAULT_ATTRIBUTE = 'data-color-scheme';

export interface InitColorSchemeScriptProps {
/**
* The default mode when the storage is empty (user's first visit)
Copy link
Member

@oliviertassinari oliviertassinari Oct 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
* The default mode when the storage is empty (user's first visit)
* The default mode when the storage is empty (user's first visit).

x al the others on this file.

Edit. Fixed in #44187.

* @default 'system'
*/
defaultMode?: 'system' | 'light' | 'dark';
Copy link
Member

@oliviertassinari oliviertassinari Oct 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not sure about the prop name: "default"? It sounds more like "initial" as there is a notion of session. Should we rename it?

/**
* The default color scheme to be used on the light mode
* @default 'light'
Expand Down Expand Up @@ -49,6 +54,7 @@ export interface InitColorSchemeScriptProps {

export default function InitColorSchemeScript(options?: InitColorSchemeScriptProps) {
const {
defaultMode = 'system',
defaultLightColorScheme = 'light',
defaultDarkColorScheme = 'dark',
modeStorageKey = DEFAULT_MODE_STORAGE_KEY,
Expand Down Expand Up @@ -93,7 +99,7 @@ export default function InitColorSchemeScript(options?: InitColorSchemeScriptPro
__html: `(function() {
try {
let colorScheme = '';
const mode = localStorage.getItem('${modeStorageKey}') || 'system';
const mode = localStorage.getItem('${modeStorageKey}') || '${defaultMode}';
const dark = localStorage.getItem('${colorSchemeStorageKey}-dark') || '${defaultDarkColorScheme}';
const light = localStorage.getItem('${colorSchemeStorageKey}-light') || '${defaultLightColorScheme}';
if (mode === 'system') {
Expand Down
Loading