@mui/system 5.0.6 → 5.1.0

package/cssVars/createCssVarsProvider.js

@@ -21,8 +21,12 @@ var _styledEngine = require("@mui/styled-engine");
 
 var _cssVarsParser = _interopRequireDefault(require("./cssVarsParser"));
 
+var _ThemeProvider = _interopRequireDefault(require("../ThemeProvider"));
+
 var _getInitColorSchemeScript = _interopRequireWildcard(require("./getInitColorSchemeScript"));
 
+var _useCurrentColorScheme = _interopRequireDefault(require("./useCurrentColorScheme"));
+
 var _jsxRuntime = require("react/jsx-runtime");
 
 const _excluded = ["colorSchemes"],
@@ -32,33 +36,16 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-const resolveMode = (key, fallback, supportedColorSchemes) => {
-  if (typeof window === 'undefined') {
-    return undefined;
-  }
-
-  let value;
-
-  try {
-    value = localStorage.getItem(key) || undefined;
-
-    if (!supportedColorSchemes.includes(value)) {
-      value = undefined;
-    }
-  } catch (e) {// Unsupported
-  }
-
-  return value || fallback;
-};
-
-function createCssVarsProvider(ThemeContext, options) {
+function createCssVarsProvider(options) {
   const {
     theme: baseTheme = {},
+    defaultMode: desisgnSystemMode = 'light',
     defaultColorScheme: designSystemColorScheme,
-    prefix: designSystemPrefix = ''
+    prefix: designSystemPrefix = '',
+    shouldSkipGeneratingVar
   } = options;
 
-  if (!baseTheme.colorSchemes || !baseTheme.colorSchemes[designSystemColorScheme]) {
+  if (!baseTheme.colorSchemes || typeof designSystemColorScheme === 'string' && !baseTheme.colorSchemes[designSystemColorScheme] || typeof designSystemColorScheme === 'object' && !baseTheme.colorSchemes[designSystemColorScheme == null ? void 0 : designSystemColorScheme.light] || typeof designSystemColorScheme === 'object' && !baseTheme.colorSchemes[designSystemColorScheme == null ? void 0 : designSystemColorScheme.dark]) {
     console.error(`MUI: \`${designSystemColorScheme}\` does not exist in \`theme.colorSchemes\`.`);
   }
 
@@ -78,8 +65,9 @@ function createCssVarsProvider(ThemeContext, options) {
     children,
     theme: themeProp = {},
     prefix = designSystemPrefix,
-    storageKey = _getInitColorSchemeScript.DEFAULT_STORAGE_KEY,
+    modeStorageKey = _getInitColorSchemeScript.DEFAULT_MODE_STORAGE_KEY,
     attribute = _getInitColorSchemeScript.DEFAULT_ATTRIBUTE,
+    defaultMode = desisgnSystemMode,
     defaultColorScheme = designSystemColorScheme
   }) {
     const {
@@ -93,14 +81,44 @@ function createCssVarsProvider(ThemeContext, options) {
     let mergedTheme = (0, _utils.deepmerge)(restBaseTheme, restThemeProp);
     const colorSchemes = (0, _utils.deepmerge)(baseColorSchemes, colorSchemesProp);
     const allColorSchemes = Object.keys(colorSchemes);
-    const joinedColorSchemes = allColorSchemes.join(',');
-    const [colorScheme, setColorScheme] = React.useState(() => resolveMode(storageKey, defaultColorScheme, allColorSchemes));
-    const resolvedColorScheme = colorScheme || defaultColorScheme;
+    const defaultLightColorScheme = typeof defaultColorScheme === 'string' ? defaultColorScheme : defaultColorScheme.light;
+    const defaultDarkColorScheme = typeof defaultColorScheme === 'string' ? defaultColorScheme : defaultColorScheme.dark;
+    const {
+      mode,
+      setMode,
+      lightColorScheme,
+      darkColorScheme,
+      colorScheme,
+      setColorScheme
+    } = (0, _useCurrentColorScheme.default)({
+      supportedColorSchemes: allColorSchemes,
+      defaultLightColorScheme,
+      defaultDarkColorScheme,
+      modeStorageKey,
+      defaultMode
+    });
+
+    const resolvedColorScheme = (() => {
+      if (!colorScheme) {
+        // This scope occurs on the server
+        if (defaultMode === 'dark') {
+          return defaultDarkColorScheme;
+        } // use light color scheme, if default mode is 'light' | 'auto'
+
+
+        return defaultLightColorScheme;
+      }
+
+      return colorScheme;
+    })();
+
     const {
       css: rootCss,
       vars: rootVars
     } = (0, _cssVarsParser.default)(mergedTheme, {
-      prefix
+      prefix,
+      basePrefix: designSystemPrefix,
+      shouldSkipGeneratingVar
     });
     mergedTheme = (0, _extends2.default)({}, mergedTheme, colorSchemes[resolvedColorScheme], {
       vars: rootVars
@@ -111,15 +129,29 @@ function createCssVarsProvider(ThemeContext, options) {
         css,
         vars
       } = (0, _cssVarsParser.default)(scheme, {
-        prefix
+        prefix,
+        basePrefix: designSystemPrefix,
+        shouldSkipGeneratingVar
       });
 
       if (key === resolvedColorScheme) {
         mergedTheme.vars = (0, _extends2.default)({}, mergedTheme.vars, vars);
       }
 
-      if (key === defaultColorScheme) {
-        styleSheet[':root'] = (0, _utils.deepmerge)(rootCss, css);
+      const resolvedDefaultColorScheme = (() => {
+        if (typeof defaultColorScheme === 'string') {
+          return defaultColorScheme;
+        }
+
+        if (defaultMode === 'dark') {
+          return defaultColorScheme.dark;
+        }
+
+        return defaultColorScheme.light;
+      })();
+
+      if (key === resolvedDefaultColorScheme) {
+        styleSheet[':root'] = css;
       } else {
         styleSheet[`[${attribute}="${key}"]`] = css;
       }
@@ -127,41 +159,26 @@ function createCssVarsProvider(ThemeContext, options) {
     React.useEffect(() => {
       if (colorScheme) {
         document.body.setAttribute(attribute, colorScheme);
-        localStorage.setItem(storageKey, colorScheme);
-      }
-    }, [colorScheme, attribute, storageKey]); // local storage modified in the context of another document
-
-    React.useEffect(() => {
-      const handleStorage = event => {
-        const storageColorScheme = event.newValue;
-
-        if (event.key === storageKey && joinedColorSchemes.match(storageColorScheme)) {
-          if (storageColorScheme) {
-            setColorScheme(storageColorScheme);
-          }
-        }
-      };
-
-      window.addEventListener('storage', handleStorage);
-      return () => window.removeEventListener('storage', handleStorage);
-    }, [setColorScheme, storageKey, joinedColorSchemes]);
-    const wrappedSetColorScheme = React.useCallback(val => {
-      if (typeof val === 'string' && !allColorSchemes.includes(val)) {
-        console.error(`\`${val}\` does not exist in \`theme.colorSchemes\`.`);
-      } else {
-        setColorScheme(val);
       }
-    }, [setColorScheme, allColorSchemes]);
+    }, [colorScheme, attribute]);
     return /*#__PURE__*/(0, _jsxRuntime.jsxs)(ColorSchemeContext.Provider, {
       value: {
+        mode,
+        setMode,
+        lightColorScheme,
+        darkColorScheme,
         colorScheme,
-        setColorScheme: wrappedSetColorScheme,
+        setColorScheme,
         allColorSchemes
       },
       children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_styledEngine.GlobalStyles, {
+        styles: {
+          ':root': rootCss
+        }
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_styledEngine.GlobalStyles, {
         styles: styleSheet
-      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(ThemeContext.Provider, {
-        value: mergedTheme,
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_ThemeProvider.default, {
+        theme: mergedTheme,
         children: children
       })]
     });
@@ -181,17 +198,22 @@ function createCssVarsProvider(ThemeContext, options) {
     /**
      * The initial color scheme used.
      */
-    defaultColorScheme: _propTypes.default.string,
+    defaultColorScheme: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object]),
 
     /**
-     * css variable prefix
+     * The initial mode used.
      */
-    prefix: _propTypes.default.string,
+    defaultMode: _propTypes.default.string,
 
     /**
      * The key in the local storage used to store current color scheme.
      */
-    storageKey: _propTypes.default.string,
+    modeStorageKey: _propTypes.default.string,
+
+    /**
+     * css variable prefix
+     */
+    prefix: _propTypes.default.string,
 
     /**
      * The calculated theme object that will be passed through context.

package/cssVars/cssVarsParser.d.ts

@@ -30,12 +30,21 @@ export declare const assignNestedKeys: <Object_1 = NestedRecord<any>, Value = an
  * walkObjectDeep({ palette: { primary: { main: '#000000' } } }, console.log)
  * // ['palette', 'primary', 'main'] '#000000'
  */
-export declare const walkObjectDeep: <Value, T = Record<string, any>>(obj: T, callback: (keys: Array<string>, value: Value) => void) => void;
+export declare const walkObjectDeep: <Value, T = Record<string, any>>(obj: T, callback: (keys: Array<string>, value: Value, scope: Record<string, string | number>) => void) => void;
 /**
  * a function that parse theme and return { css, vars }
  *
  * @param {Object} theme
- * @param {{ prefix?: string }} options
+ * @param {{
+ *  prefix?: string,
+ *  basePrefix?: string,
+ *  shouldSkipGeneratingVar?: (objectPathKeys: Array<string>, value: string | number) => boolean
+ * }} options.
+ *  `basePrefix`: defined by design system.
+ *  `prefix`: defined by application
+ *
+ *   This function also mutate the string value of theme input by replacing `basePrefix` (if existed) with `prefix`
+ *
  * @returns {{ css: Object, vars: Object }} `css` is the stylesheet, `vars` is an object to get css variable (same structure as theme)
  *
  * @example
@@ -48,8 +57,10 @@ export declare const walkObjectDeep: <Value, T = Record<string, any>>(obj: T, ca
  * console.log(css) // { '--fontSize': '12px', '--lineHeight': 1.2, '--palette-primary-500': '#000000' }
  * console.log(vars) // { fontSize: '--fontSize', lineHeight: '--lineHeight', palette: { primary: { 500: 'var(--palette-primary-500)' } } }
  */
-export default function cssVarsParser(obj: Record<string, any>, options?: {
+export default function cssVarsParser(theme: Record<string, any>, options?: {
     prefix?: string;
+    basePrefix?: string;
+    shouldSkipGeneratingVar?: (objectPathKeys: Array<string>, value: string | number) => boolean;
 }): {
     css: NestedRecord<string>;
     vars: NestedRecord<string>;

package/cssVars/cssVarsParser.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -7,6 +9,8 @@ exports.assignNestedKeys = void 0;
 exports.default = cssVarsParser;
 exports.walkObjectDeep = void 0;
 
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
 /**
  * This function create an object from keys, value and then assign to target
  *
@@ -62,7 +66,7 @@ const walkObjectDeep = (obj, callback) => {
         if (typeof value === 'object' && Object.keys(value).length > 0) {
           recurse(value, [...parentKeys, key]);
         } else {
-          callback([...parentKeys, key], value);
+          callback([...parentKeys, key], value, object);
         }
       }
     });
@@ -89,7 +93,16 @@ const getCssValue = (keys, value) => {
  * a function that parse theme and return { css, vars }
  *
  * @param {Object} theme
- * @param {{ prefix?: string }} options
+ * @param {{
+ *  prefix?: string,
+ *  basePrefix?: string,
+ *  shouldSkipGeneratingVar?: (objectPathKeys: Array<string>, value: string | number) => boolean
+ * }} options.
+ *  `basePrefix`: defined by design system.
+ *  `prefix`: defined by application
+ *
+ *   This function also mutate the string value of theme input by replacing `basePrefix` (if existed) with `prefix`
+ *
  * @returns {{ css: Object, vars: Object }} `css` is the stylesheet, `vars` is an object to get css variable (same structure as theme)
  *
  * @example
@@ -104,19 +117,36 @@ const getCssValue = (keys, value) => {
  */
 
 
-function cssVarsParser(obj, options) {
+function cssVarsParser(theme, options) {
+  const clonedTheme = (0, _extends2.default)({}, theme);
+  delete clonedTheme.vars; // remove 'vars' from the structure
+
   const {
-    prefix
+    prefix,
+    basePrefix = '',
+    shouldSkipGeneratingVar
   } = options || {};
   const css = {};
   const vars = {};
-  walkObjectDeep(obj, (keys, value) => {
-    if (typeof value === 'string' || typeof value === 'number') {
-      const cssVar = `--${prefix ? `${prefix}-` : ''}${keys.join('-')}`;
-      Object.assign(css, {
-        [cssVar]: getCssValue(keys, value)
-      });
-      assignNestedKeys(vars, keys, `var(${cssVar})`);
+  walkObjectDeep(clonedTheme, (keys, val, scope) => {
+    if (typeof val === 'string' || typeof val === 'number') {
+      let value = val;
+
+      if (typeof value === 'string' && value.startsWith('var')) {
+        // replace the value of the `scope` object with the prefix or remove basePrefix from the value
+        value = prefix ? value.replace(basePrefix, prefix) : value.replace(`${basePrefix}-`, ''); // scope is the deepest object in the tree, keys is the theme path keys
+
+        scope[keys.slice(-1)[0]] = value;
+      }
+
+      if (!shouldSkipGeneratingVar || shouldSkipGeneratingVar && !shouldSkipGeneratingVar(keys, value)) {
+        // only create css & var if `shouldSkipGeneratingVar` return false
+        const cssVar = `--${prefix ? `${prefix}-` : ''}${keys.join('-')}`;
+        Object.assign(css, {
+          [cssVar]: getCssValue(keys, value)
+        });
+        assignNestedKeys(vars, keys, `var(${cssVar})`);
+      }
     }
   });
   return {

package/cssVars/getInitColorSchemeScript.d.ts

@@ -1,7 +1,12 @@
 /// <reference types="react" />
-export declare const DEFAULT_STORAGE_KEY = "mui-color-scheme";
+export declare const DEFAULT_MODE_STORAGE_KEY = "mui-mode";
+export declare const DEFAULT_COLOR_SCHEME_STORAGE_KEY = "mui-color-scheme";
 export declare const DEFAULT_ATTRIBUTE = "data-mui-color-scheme";
 export default function getInitColorSchemeScript(options?: {
-    storageKey?: string;
+    defaultMode?: 'light' | 'dark' | 'system';
+    defaultLightColorScheme?: string;
+    defaultDarkColorScheme?: string;
+    modeStorageKey?: string;
+    colorSchemeStorageKey?: string;
     attribute?: string;
 }): JSX.Element;

package/cssVars/getInitColorSchemeScript.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DEFAULT_STORAGE_KEY = exports.DEFAULT_ATTRIBUTE = void 0;
+exports.DEFAULT_MODE_STORAGE_KEY = exports.DEFAULT_COLOR_SCHEME_STORAGE_KEY = exports.DEFAULT_ATTRIBUTE = void 0;
 exports.default = getInitColorSchemeScript;
 
 var React = _interopRequireWildcard(require("react"));
@@ -14,21 +14,43 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-const DEFAULT_STORAGE_KEY = 'mui-color-scheme';
-exports.DEFAULT_STORAGE_KEY = DEFAULT_STORAGE_KEY;
+const DEFAULT_MODE_STORAGE_KEY = 'mui-mode';
+exports.DEFAULT_MODE_STORAGE_KEY = DEFAULT_MODE_STORAGE_KEY;
+const DEFAULT_COLOR_SCHEME_STORAGE_KEY = 'mui-color-scheme';
+exports.DEFAULT_COLOR_SCHEME_STORAGE_KEY = DEFAULT_COLOR_SCHEME_STORAGE_KEY;
 const DEFAULT_ATTRIBUTE = 'data-mui-color-scheme';
 exports.DEFAULT_ATTRIBUTE = DEFAULT_ATTRIBUTE;
 
 function getInitColorSchemeScript(options) {
   const {
-    storageKey = DEFAULT_STORAGE_KEY,
+    defaultMode = 'light',
+    defaultLightColorScheme = 'light',
+    defaultDarkColorScheme = 'dark',
+    modeStorageKey = DEFAULT_MODE_STORAGE_KEY,
+    colorSchemeStorageKey = DEFAULT_COLOR_SCHEME_STORAGE_KEY,
     attribute = DEFAULT_ATTRIBUTE
   } = options || {};
   return /*#__PURE__*/(0, _jsxRuntime.jsx)("script", {
     // eslint-disable-next-line react/no-danger
     dangerouslySetInnerHTML: {
       __html: `(function() { try {
-        var colorScheme = localStorage.getItem('${storageKey}');
+        var mode = localStorage.getItem('${modeStorageKey}');
+        var colorScheme = '';
+        if (mode === 'system' || (!mode && ${defaultMode} === 'system')) {
+          // handle system mode
+          var mql = window.matchMedia('(prefers-color-scheme: dark)');
+          if (mql.matches) {
+            colorScheme = localStorage.getItem('${colorSchemeStorageKey}-dark') || ${defaultLightColorScheme};
+          } else {
+            colorScheme = localStorage.getItem('${colorSchemeStorageKey}-light') || ${defaultDarkColorScheme};
+          }
+        }
+        if (mode === 'light') {
+          colorScheme = localStorage.getItem('${colorSchemeStorageKey}-light') || ${defaultLightColorScheme};
+        }
+        if (mode === 'dark') {
+          colorScheme = localStorage.getItem('${colorSchemeStorageKey}-dark') || ${defaultDarkColorScheme};
+        }
         if (colorScheme) {
           document.body.setAttribute('${attribute}', colorScheme);
         }

package/cssVars/useCurrentColorScheme.d.ts

@@ -0,0 +1,50 @@
+export declare type Mode = 'light' | 'dark' | 'system';
+export declare type SystemMode = Exclude<Mode, 'system'>;
+export interface State<SupportedColorScheme extends string> {
+    /**
+     * User selected mode.
+     * Note: on the server, mode is always undefined
+     */
+    mode: Mode | undefined;
+    /**
+     * Only valid if `mode: 'system'`, either 'light' | 'dark'.
+     */
+    systemMode: SystemMode | undefined;
+    /**
+     * The color scheme for the light mode.
+     */
+    lightColorScheme: SupportedColorScheme;
+    /**
+     * The color scheme for the dark mode.
+     */
+    darkColorScheme: SupportedColorScheme;
+}
+export declare type Result<SupportedColorScheme extends string> = State<SupportedColorScheme> & {
+    /**
+     * The current application color scheme. It is always `undefined` on the server.
+     */
+    colorScheme: SupportedColorScheme | undefined;
+    /**
+     * `mode` is saved to internal state and localStorage
+     * If `mode` is null, it will be reset to the defaultMode
+     */
+    setMode: (mode: Mode | null) => void;
+    /**
+     * `colorScheme` is saved to internal state and localStorage
+     * If `colorScheme` is null, it will be reset to the defaultColorScheme (light | dark)
+     */
+    setColorScheme: (colorScheme: SupportedColorScheme | Partial<{
+        light: SupportedColorScheme | null;
+        dark: SupportedColorScheme | null;
+    }> | null) => void;
+};
+export declare function getSystemMode(mode: undefined | string): SystemMode | undefined;
+export declare function getColorScheme<SupportedColorScheme extends string>(state: State<SupportedColorScheme>): SupportedColorScheme | undefined;
+export default function useCurrentColorScheme<SupportedColorScheme extends string>(options: {
+    defaultLightColorScheme: SupportedColorScheme;
+    defaultDarkColorScheme: SupportedColorScheme;
+    supportedColorSchemes: Array<SupportedColorScheme>;
+    defaultMode?: Mode;
+    modeStorageKey?: string;
+    colorSchemeStorageKey?: string;
+}): Result<SupportedColorScheme>;