@mui/system 5.10.1 → 5.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,45 +1,45 @@
1
- /// <reference types="react" />
2
- export declare const DEFAULT_MODE_STORAGE_KEY = "mode";
3
- export declare const DEFAULT_COLOR_SCHEME_STORAGE_KEY = "color-scheme";
4
- export declare const DEFAULT_ATTRIBUTE = "data-color-scheme";
5
- export interface GetInitColorSchemeScriptOptions {
6
- /**
7
- * Indicate to the browser which color scheme is used (light or dark) for rendering built-in UI
8
- * @default true
9
- */
10
- enableColorScheme?: boolean;
11
- /**
12
- * If `true`, the initial color scheme is set to the user's prefers-color-scheme mode
13
- * @default false
14
- */
15
- enableSystem?: boolean;
16
- /**
17
- * The default color scheme to be used on the light mode
18
- */
19
- defaultLightColorScheme?: string;
20
- /**
21
- * The default color scheme to be used on the dark mode
22
- */
23
- defaultDarkColorScheme?: string;
24
- /**
25
- * The node (provided as string) used to attach the color-scheme attribute
26
- * @default 'document.documentElement'
27
- */
28
- colorSchemeNode?: string;
29
- /**
30
- * localStorage key used to store `mode`
31
- * @default 'mode'
32
- */
33
- modeStorageKey?: string;
34
- /**
35
- * localStorage key used to store `colorScheme`
36
- * @default 'color-scheme'
37
- */
38
- colorSchemeStorageKey?: string;
39
- /**
40
- * DOM attribute for applying color scheme
41
- * @default 'data-color-scheme'
42
- */
43
- attribute?: string;
44
- }
45
- export default function getInitColorSchemeScript(options?: GetInitColorSchemeScriptOptions): JSX.Element;
1
+ /// <reference types="react" />
2
+ export declare const DEFAULT_MODE_STORAGE_KEY = "mode";
3
+ export declare const DEFAULT_COLOR_SCHEME_STORAGE_KEY = "color-scheme";
4
+ export declare const DEFAULT_ATTRIBUTE = "data-color-scheme";
5
+ export interface GetInitColorSchemeScriptOptions {
6
+ /**
7
+ * Indicate to the browser which color scheme is used (light or dark) for rendering built-in UI
8
+ * @default true
9
+ */
10
+ enableColorScheme?: boolean;
11
+ /**
12
+ * If `true`, the initial color scheme is set to the user's prefers-color-scheme mode
13
+ * @default false
14
+ */
15
+ enableSystem?: boolean;
16
+ /**
17
+ * The default color scheme to be used on the light mode
18
+ */
19
+ defaultLightColorScheme?: string;
20
+ /**
21
+ * The default color scheme to be used on the dark mode
22
+ */
23
+ defaultDarkColorScheme?: string;
24
+ /**
25
+ * The node (provided as string) used to attach the color-scheme attribute
26
+ * @default 'document.documentElement'
27
+ */
28
+ colorSchemeNode?: string;
29
+ /**
30
+ * localStorage key used to store `mode`
31
+ * @default 'mode'
32
+ */
33
+ modeStorageKey?: string;
34
+ /**
35
+ * localStorage key used to store `colorScheme`
36
+ * @default 'color-scheme'
37
+ */
38
+ colorSchemeStorageKey?: string;
39
+ /**
40
+ * DOM attribute for applying color scheme
41
+ * @default 'data-color-scheme'
42
+ */
43
+ attribute?: string;
44
+ }
45
+ export default function getInitColorSchemeScript(options?: GetInitColorSchemeScriptOptions): JSX.Element;
@@ -1,3 +1,3 @@
1
- export { default } from './createCssVarsProvider';
2
- export type { CreateCssVarsProviderResult, CssVarsProviderConfig, ColorSchemeContextValue, } from './createCssVarsProvider';
3
- export { default as getInitColorSchemeScript } from './getInitColorSchemeScript';
1
+ export { default } from './createCssVarsProvider';
2
+ export type { CreateCssVarsProviderResult, CssVarsProviderConfig, ColorSchemeContextValue, } from './createCssVarsProvider';
3
+ export { default as getInitColorSchemeScript } from './getInitColorSchemeScript';
@@ -1,53 +1,53 @@
1
- export declare type Mode = 'light' | 'dark' | 'system';
2
- export declare type SystemMode = Exclude<Mode, 'system'>;
3
- export interface State<SupportedColorScheme extends string> {
4
- /**
5
- * User selected mode.
6
- * Note: on the server, mode is always undefined
7
- */
8
- mode: Mode | undefined;
9
- /**
10
- * Only valid if `mode: 'system'`, either 'light' | 'dark'.
11
- */
12
- systemMode: SystemMode | undefined;
13
- /**
14
- * The color scheme for the light mode.
15
- */
16
- lightColorScheme: SupportedColorScheme;
17
- /**
18
- * The color scheme for the dark mode.
19
- */
20
- darkColorScheme: SupportedColorScheme;
21
- }
22
- export declare type Result<SupportedColorScheme extends string> = State<SupportedColorScheme> & {
23
- /**
24
- * The current application color scheme. It is always `undefined` on the server.
25
- */
26
- colorScheme: SupportedColorScheme | undefined;
27
- /**
28
- * `mode` is saved to internal state and localStorage
29
- * If `mode` is null, it will be reset to the defaultMode
30
- */
31
- setMode: (mode: Mode | null) => void;
32
- /**
33
- * `colorScheme` is saved to internal state and localStorage
34
- * If `colorScheme` is null, it will be reset to the defaultColorScheme (light | dark)
35
- */
36
- setColorScheme: (colorScheme: SupportedColorScheme | Partial<{
37
- light: SupportedColorScheme | null;
38
- dark: SupportedColorScheme | null;
39
- }> | null) => void;
40
- };
41
- export declare function getSystemMode(mode: undefined | string): SystemMode | undefined;
42
- export declare function getColorScheme<SupportedColorScheme extends string>(state: State<SupportedColorScheme>): SupportedColorScheme | undefined;
43
- interface UseCurrentColoSchemeOptions<SupportedColorScheme extends string> {
44
- defaultLightColorScheme: SupportedColorScheme;
45
- defaultDarkColorScheme: SupportedColorScheme;
46
- supportedColorSchemes: Array<SupportedColorScheme>;
47
- defaultMode?: Mode;
48
- modeStorageKey?: string;
49
- colorSchemeStorageKey?: string;
50
- storageWindow?: Window | null;
51
- }
52
- export default function useCurrentColorScheme<SupportedColorScheme extends string>(options: UseCurrentColoSchemeOptions<SupportedColorScheme>): Result<SupportedColorScheme>;
53
- export {};
1
+ export declare type Mode = 'light' | 'dark' | 'system';
2
+ export declare type SystemMode = Exclude<Mode, 'system'>;
3
+ export interface State<SupportedColorScheme extends string> {
4
+ /**
5
+ * User selected mode.
6
+ * Note: on the server, mode is always undefined
7
+ */
8
+ mode: Mode | undefined;
9
+ /**
10
+ * Only valid if `mode: 'system'`, either 'light' | 'dark'.
11
+ */
12
+ systemMode: SystemMode | undefined;
13
+ /**
14
+ * The color scheme for the light mode.
15
+ */
16
+ lightColorScheme: SupportedColorScheme;
17
+ /**
18
+ * The color scheme for the dark mode.
19
+ */
20
+ darkColorScheme: SupportedColorScheme;
21
+ }
22
+ export declare type Result<SupportedColorScheme extends string> = State<SupportedColorScheme> & {
23
+ /**
24
+ * The current application color scheme. It is always `undefined` on the server.
25
+ */
26
+ colorScheme: SupportedColorScheme | undefined;
27
+ /**
28
+ * `mode` is saved to internal state and localStorage
29
+ * If `mode` is null, it will be reset to the defaultMode
30
+ */
31
+ setMode: (mode: Mode | null) => void;
32
+ /**
33
+ * `colorScheme` is saved to internal state and localStorage
34
+ * If `colorScheme` is null, it will be reset to the defaultColorScheme (light | dark)
35
+ */
36
+ setColorScheme: (colorScheme: SupportedColorScheme | Partial<{
37
+ light: SupportedColorScheme | null;
38
+ dark: SupportedColorScheme | null;
39
+ }> | null) => void;
40
+ };
41
+ export declare function getSystemMode(mode: undefined | string): SystemMode | undefined;
42
+ export declare function getColorScheme<SupportedColorScheme extends string>(state: State<SupportedColorScheme>): SupportedColorScheme | undefined;
43
+ interface UseCurrentColoSchemeOptions<SupportedColorScheme extends string> {
44
+ defaultLightColorScheme: SupportedColorScheme;
45
+ defaultDarkColorScheme: SupportedColorScheme;
46
+ supportedColorSchemes: Array<SupportedColorScheme>;
47
+ defaultMode?: Mode;
48
+ modeStorageKey?: string;
49
+ colorSchemeStorageKey?: string;
50
+ storageWindow?: Window | null;
51
+ }
52
+ export default function useCurrentColorScheme<SupportedColorScheme extends string>(options: UseCurrentColoSchemeOptions<SupportedColorScheme>): Result<SupportedColorScheme>;
53
+ export {};
@@ -103,8 +103,9 @@ function useCurrentColorScheme(options) {
103
103
  return currentState;
104
104
  }
105
105
 
106
- if (typeof localStorage !== 'undefined') {
106
+ try {
107
107
  localStorage.setItem(modeStorageKey, newMode);
108
+ } catch (e) {// Unsupported
108
109
  }
109
110
 
110
111
  return (0, _extends2.default)({}, currentState, {
@@ -129,7 +130,10 @@ function useCurrentColorScheme(options) {
129
130
  }
130
131
 
131
132
  processState(currentState, mode => {
132
- localStorage.setItem(`${colorSchemeStorageKey}-${mode}`, value);
133
+ try {
134
+ localStorage.setItem(`${colorSchemeStorageKey}-${mode}`, value);
135
+ } catch (e) {// Unsupported
136
+ }
133
137
 
134
138
  if (mode === 'light') {
135
139
  newState.lightColorScheme = value;
@@ -159,12 +163,15 @@ function useCurrentColorScheme(options) {
159
163
  return newState;
160
164
  });
161
165
 
162
- if (value.light) {
163
- localStorage.setItem(`${colorSchemeStorageKey}-light`, value.light);
164
- }
166
+ try {
167
+ if (value.light) {
168
+ localStorage.setItem(`${colorSchemeStorageKey}-light`, value.light);
169
+ }
165
170
 
166
- if (value.dark) {
167
- localStorage.setItem(`${colorSchemeStorageKey}-dark`, value.dark);
171
+ if (value.dark) {
172
+ localStorage.setItem(`${colorSchemeStorageKey}-dark`, value.dark);
173
+ }
174
+ } catch (e) {// Unsupported
168
175
  }
169
176
  }
170
177
  }, [joinedColorSchemes, colorSchemeStorageKey, defaultLightColorScheme, defaultDarkColorScheme]);
@@ -190,19 +197,22 @@ function useCurrentColorScheme(options) {
190
197
  }, []); // Save mode, lightColorScheme & darkColorScheme to localStorage
191
198
 
192
199
  React.useEffect(() => {
193
- if (state.mode) {
194
- localStorage.setItem(modeStorageKey, state.mode);
195
- }
196
-
197
- processState(state, mode => {
198
- if (mode === 'light') {
199
- localStorage.setItem(`${colorSchemeStorageKey}-light`, state.lightColorScheme);
200
+ try {
201
+ if (state.mode) {
202
+ localStorage.setItem(modeStorageKey, state.mode);
200
203
  }
201
204
 
202
- if (mode === 'dark') {
203
- localStorage.setItem(`${colorSchemeStorageKey}-dark`, state.darkColorScheme);
204
- }
205
- });
205
+ processState(state, mode => {
206
+ if (mode === 'light') {
207
+ localStorage.setItem(`${colorSchemeStorageKey}-light`, state.lightColorScheme);
208
+ }
209
+
210
+ if (mode === 'dark') {
211
+ localStorage.setItem(`${colorSchemeStorageKey}-dark`, state.darkColorScheme);
212
+ }
213
+ });
214
+ } catch (e) {// Unsupported
215
+ }
206
216
  }, [state, colorSchemeStorageKey, modeStorageKey]); // Handle when localStorage has changed
207
217
 
208
218
  React.useEffect(() => {
@@ -85,8 +85,9 @@ export default function useCurrentColorScheme(options) {
85
85
  return currentState;
86
86
  }
87
87
 
88
- if (typeof localStorage !== 'undefined') {
88
+ try {
89
89
  localStorage.setItem(modeStorageKey, newMode);
90
+ } catch (e) {// Unsupported
90
91
  }
91
92
 
92
93
  return _extends({}, currentState, {
@@ -111,7 +112,10 @@ export default function useCurrentColorScheme(options) {
111
112
  }
112
113
 
113
114
  processState(currentState, mode => {
114
- localStorage.setItem(`${colorSchemeStorageKey}-${mode}`, value);
115
+ try {
116
+ localStorage.setItem(`${colorSchemeStorageKey}-${mode}`, value);
117
+ } catch (e) {// Unsupported
118
+ }
115
119
 
116
120
  if (mode === 'light') {
117
121
  newState.lightColorScheme = value;
@@ -141,12 +145,15 @@ export default function useCurrentColorScheme(options) {
141
145
  return newState;
142
146
  });
143
147
 
144
- if (value.light) {
145
- localStorage.setItem(`${colorSchemeStorageKey}-light`, value.light);
146
- }
148
+ try {
149
+ if (value.light) {
150
+ localStorage.setItem(`${colorSchemeStorageKey}-light`, value.light);
151
+ }
147
152
 
148
- if (value.dark) {
149
- localStorage.setItem(`${colorSchemeStorageKey}-dark`, value.dark);
153
+ if (value.dark) {
154
+ localStorage.setItem(`${colorSchemeStorageKey}-dark`, value.dark);
155
+ }
156
+ } catch (e) {// Unsupported
150
157
  }
151
158
  }
152
159
  }, [joinedColorSchemes, colorSchemeStorageKey, defaultLightColorScheme, defaultDarkColorScheme]);
@@ -172,19 +179,22 @@ export default function useCurrentColorScheme(options) {
172
179
  }, []); // Save mode, lightColorScheme & darkColorScheme to localStorage
173
180
 
174
181
  React.useEffect(() => {
175
- if (state.mode) {
176
- localStorage.setItem(modeStorageKey, state.mode);
177
- }
178
-
179
- processState(state, mode => {
180
- if (mode === 'light') {
181
- localStorage.setItem(`${colorSchemeStorageKey}-light`, state.lightColorScheme);
182
+ try {
183
+ if (state.mode) {
184
+ localStorage.setItem(modeStorageKey, state.mode);
182
185
  }
183
186
 
184
- if (mode === 'dark') {
185
- localStorage.setItem(`${colorSchemeStorageKey}-dark`, state.darkColorScheme);
186
- }
187
- });
187
+ processState(state, mode => {
188
+ if (mode === 'light') {
189
+ localStorage.setItem(`${colorSchemeStorageKey}-light`, state.lightColorScheme);
190
+ }
191
+
192
+ if (mode === 'dark') {
193
+ localStorage.setItem(`${colorSchemeStorageKey}-dark`, state.darkColorScheme);
194
+ }
195
+ });
196
+ } catch (e) {// Unsupported
197
+ }
188
198
  }, [state, colorSchemeStorageKey, modeStorageKey]); // Handle when localStorage has changed
189
199
 
190
200
  React.useEffect(() => {
package/index.js CHANGED
@@ -1,4 +1,4 @@
1
- /** @license MUI v5.10.1
1
+ /** @license MUI v5.10.2
2
2
  *
3
3
  * This source code is licensed under the MIT license found in the
4
4
  * LICENSE file in the root directory of this source tree.
package/index.spec.d.ts CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -92,8 +92,9 @@ export default function useCurrentColorScheme(options) {
92
92
  return currentState;
93
93
  }
94
94
 
95
- if (typeof localStorage !== 'undefined') {
95
+ try {
96
96
  localStorage.setItem(modeStorageKey, newMode);
97
+ } catch (e) {// Unsupported
97
98
  }
98
99
 
99
100
  return _extends({}, currentState, {
@@ -118,7 +119,10 @@ export default function useCurrentColorScheme(options) {
118
119
  }
119
120
 
120
121
  processState(currentState, function (mode) {
121
- localStorage.setItem("".concat(colorSchemeStorageKey, "-").concat(mode), value);
122
+ try {
123
+ localStorage.setItem("".concat(colorSchemeStorageKey, "-").concat(mode), value);
124
+ } catch (e) {// Unsupported
125
+ }
122
126
 
123
127
  if (mode === 'light') {
124
128
  newState.lightColorScheme = value;
@@ -148,12 +152,15 @@ export default function useCurrentColorScheme(options) {
148
152
  return newState;
149
153
  });
150
154
 
151
- if (value.light) {
152
- localStorage.setItem("".concat(colorSchemeStorageKey, "-light"), value.light);
153
- }
155
+ try {
156
+ if (value.light) {
157
+ localStorage.setItem("".concat(colorSchemeStorageKey, "-light"), value.light);
158
+ }
154
159
 
155
- if (value.dark) {
156
- localStorage.setItem("".concat(colorSchemeStorageKey, "-dark"), value.dark);
160
+ if (value.dark) {
161
+ localStorage.setItem("".concat(colorSchemeStorageKey, "-dark"), value.dark);
162
+ }
163
+ } catch (e) {// Unsupported
157
164
  }
158
165
  }
159
166
  }, [joinedColorSchemes, colorSchemeStorageKey, defaultLightColorScheme, defaultDarkColorScheme]);
@@ -185,19 +192,22 @@ export default function useCurrentColorScheme(options) {
185
192
  }, []); // Save mode, lightColorScheme & darkColorScheme to localStorage
186
193
 
187
194
  React.useEffect(function () {
188
- if (state.mode) {
189
- localStorage.setItem(modeStorageKey, state.mode);
190
- }
191
-
192
- processState(state, function (mode) {
193
- if (mode === 'light') {
194
- localStorage.setItem("".concat(colorSchemeStorageKey, "-light"), state.lightColorScheme);
195
+ try {
196
+ if (state.mode) {
197
+ localStorage.setItem(modeStorageKey, state.mode);
195
198
  }
196
199
 
197
- if (mode === 'dark') {
198
- localStorage.setItem("".concat(colorSchemeStorageKey, "-dark"), state.darkColorScheme);
199
- }
200
- });
200
+ processState(state, function (mode) {
201
+ if (mode === 'light') {
202
+ localStorage.setItem("".concat(colorSchemeStorageKey, "-light"), state.lightColorScheme);
203
+ }
204
+
205
+ if (mode === 'dark') {
206
+ localStorage.setItem("".concat(colorSchemeStorageKey, "-dark"), state.darkColorScheme);
207
+ }
208
+ });
209
+ } catch (e) {// Unsupported
210
+ }
201
211
  }, [state, colorSchemeStorageKey, modeStorageKey]); // Handle when localStorage has changed
202
212
 
203
213
  React.useEffect(function () {
package/legacy/index.js CHANGED
@@ -1,4 +1,4 @@
1
- /** @license MUI v5.10.1
1
+ /** @license MUI v5.10.2
2
2
  *
3
3
  * This source code is licensed under the MIT license found in the
4
4
  * LICENSE file in the root directory of this source tree.
@@ -85,8 +85,9 @@ export default function useCurrentColorScheme(options) {
85
85
  return currentState;
86
86
  }
87
87
 
88
- if (typeof localStorage !== 'undefined') {
88
+ try {
89
89
  localStorage.setItem(modeStorageKey, newMode);
90
+ } catch (e) {// Unsupported
90
91
  }
91
92
 
92
93
  return _extends({}, currentState, {
@@ -111,7 +112,10 @@ export default function useCurrentColorScheme(options) {
111
112
  }
112
113
 
113
114
  processState(currentState, mode => {
114
- localStorage.setItem(`${colorSchemeStorageKey}-${mode}`, value);
115
+ try {
116
+ localStorage.setItem(`${colorSchemeStorageKey}-${mode}`, value);
117
+ } catch (e) {// Unsupported
118
+ }
115
119
 
116
120
  if (mode === 'light') {
117
121
  newState.lightColorScheme = value;
@@ -141,12 +145,15 @@ export default function useCurrentColorScheme(options) {
141
145
  return newState;
142
146
  });
143
147
 
144
- if (value.light) {
145
- localStorage.setItem(`${colorSchemeStorageKey}-light`, value.light);
146
- }
148
+ try {
149
+ if (value.light) {
150
+ localStorage.setItem(`${colorSchemeStorageKey}-light`, value.light);
151
+ }
147
152
 
148
- if (value.dark) {
149
- localStorage.setItem(`${colorSchemeStorageKey}-dark`, value.dark);
153
+ if (value.dark) {
154
+ localStorage.setItem(`${colorSchemeStorageKey}-dark`, value.dark);
155
+ }
156
+ } catch (e) {// Unsupported
150
157
  }
151
158
  }
152
159
  }, [joinedColorSchemes, colorSchemeStorageKey, defaultLightColorScheme, defaultDarkColorScheme]);
@@ -172,19 +179,22 @@ export default function useCurrentColorScheme(options) {
172
179
  }, []); // Save mode, lightColorScheme & darkColorScheme to localStorage
173
180
 
174
181
  React.useEffect(() => {
175
- if (state.mode) {
176
- localStorage.setItem(modeStorageKey, state.mode);
177
- }
178
-
179
- processState(state, mode => {
180
- if (mode === 'light') {
181
- localStorage.setItem(`${colorSchemeStorageKey}-light`, state.lightColorScheme);
182
+ try {
183
+ if (state.mode) {
184
+ localStorage.setItem(modeStorageKey, state.mode);
182
185
  }
183
186
 
184
- if (mode === 'dark') {
185
- localStorage.setItem(`${colorSchemeStorageKey}-dark`, state.darkColorScheme);
186
- }
187
- });
187
+ processState(state, mode => {
188
+ if (mode === 'light') {
189
+ localStorage.setItem(`${colorSchemeStorageKey}-light`, state.lightColorScheme);
190
+ }
191
+
192
+ if (mode === 'dark') {
193
+ localStorage.setItem(`${colorSchemeStorageKey}-dark`, state.darkColorScheme);
194
+ }
195
+ });
196
+ } catch (e) {// Unsupported
197
+ }
188
198
  }, [state, colorSchemeStorageKey, modeStorageKey]); // Handle when localStorage has changed
189
199
 
190
200
  React.useEffect(() => {
package/modern/index.js CHANGED
@@ -1,4 +1,4 @@
1
- /** @license MUI v5.10.1
1
+ /** @license MUI v5.10.2
2
2
  *
3
3
  * This source code is licensed under the MIT license found in the
4
4
  * LICENSE file in the root directory of this source tree.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mui/system",
3
- "version": "5.10.1",
3
+ "version": "5.10.2",
4
4
  "private": false,
5
5
  "author": "MUI Team",
6
6
  "description": "CSS utilities for rapidly laying out custom designs.",
@@ -45,7 +45,7 @@
45
45
  "dependencies": {
46
46
  "@babel/runtime": "^7.17.2",
47
47
  "@mui/private-theming": "^5.9.3",
48
- "@mui/styled-engine": "^5.10.1",
48
+ "@mui/styled-engine": "^5.10.2",
49
49
  "@mui/types": "^7.1.5",
50
50
  "@mui/utils": "^5.9.3",
51
51
  "clsx": "^1.2.1",
@@ -1 +1 @@
1
- export {};
1
+ export {};