@mui/system 5.0.1 → 5.0.5

package/esm/cssVars/createCssVarsProvider.js

@@ -0,0 +1,188 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import { formatMuiErrorMessage as _formatMuiErrorMessage } from "@mui/utils";
+const _excluded = ["colorSchemes"],
+      _excluded2 = ["colorSchemes"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { GlobalStyles } from '@mui/styled-engine';
+import { deepmerge } from '@mui/utils';
+import cssVarsParser from './cssVarsParser';
+import getInitColorSchemeScript, { DEFAULT_ATTRIBUTE, DEFAULT_STORAGE_KEY } from './getInitColorSchemeScript';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+
+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;
+};
+
+export default function createCssVarsProvider(ThemeContext, options) {
+  const {
+    theme: baseTheme = {},
+    defaultColorScheme: designSystemColorScheme,
+    prefix: designSystemPrefix = ''
+  } = options;
+
+  if (!baseTheme.colorSchemes || !baseTheme.colorSchemes[designSystemColorScheme]) {
+    console.error(`MUI: \`${designSystemColorScheme}\` does not exist in \`theme.colorSchemes\`.`);
+  }
+
+  const ColorSchemeContext = /*#__PURE__*/React.createContext(undefined);
+
+  const useColorScheme = () => {
+    const value = React.useContext(ColorSchemeContext);
+
+    if (!value) {
+      throw new Error(process.env.NODE_ENV !== "production" ? `MUI: \`useColorScheme\` must be called under <CssVarsProvider />` : _formatMuiErrorMessage(19));
+    }
+
+    return value;
+  };
+
+  function CssVarsProvider({
+    children,
+    theme: themeProp = {},
+    prefix = designSystemPrefix,
+    storageKey = DEFAULT_STORAGE_KEY,
+    attribute = DEFAULT_ATTRIBUTE,
+    defaultColorScheme = designSystemColorScheme
+  }) {
+    const {
+      colorSchemes: baseColorSchemes = {}
+    } = baseTheme,
+          restBaseTheme = _objectWithoutPropertiesLoose(baseTheme, _excluded);
+
+    const {
+      colorSchemes: colorSchemesProp = {}
+    } = themeProp,
+          restThemeProp = _objectWithoutPropertiesLoose(themeProp, _excluded2);
+
+    let mergedTheme = deepmerge(restBaseTheme, restThemeProp);
+    const colorSchemes = 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 {
+      css: rootCss,
+      vars: rootVars
+    } = cssVarsParser(mergedTheme, {
+      prefix
+    });
+    mergedTheme = _extends({}, mergedTheme, colorSchemes[resolvedColorScheme], {
+      vars: rootVars
+    });
+    const styleSheet = {};
+    Object.entries(colorSchemes).forEach(([key, scheme]) => {
+      const {
+        css,
+        vars
+      } = cssVarsParser(scheme, {
+        prefix
+      });
+
+      if (key === resolvedColorScheme) {
+        mergedTheme.vars = _extends({}, mergedTheme.vars, vars);
+      }
+
+      if (key === defaultColorScheme) {
+        styleSheet[':root'] = deepmerge(rootCss, css);
+      } else {
+        styleSheet[`[${attribute}="${key}"]`] = css;
+      }
+    });
+    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]);
+    return /*#__PURE__*/_jsxs(ColorSchemeContext.Provider, {
+      value: {
+        colorScheme,
+        setColorScheme: wrappedSetColorScheme,
+        allColorSchemes
+      },
+      children: [/*#__PURE__*/_jsx(GlobalStyles, {
+        styles: styleSheet
+      }), /*#__PURE__*/_jsx(ThemeContext.Provider, {
+        value: mergedTheme,
+        children: children
+      })]
+    });
+  }
+
+  process.env.NODE_ENV !== "production" ? CssVarsProvider.propTypes = {
+    /**
+     * The body attribute name to attach colorScheme.
+     */
+    attribute: PropTypes.string,
+
+    /**
+     * Your component tree.
+     */
+    children: PropTypes.node,
+
+    /**
+     * The initial color scheme used.
+     */
+    defaultColorScheme: PropTypes.string,
+
+    /**
+     * css variable prefix
+     */
+    prefix: PropTypes.string,
+
+    /**
+     * The key in the local storage used to store current color scheme.
+     */
+    storageKey: PropTypes.string,
+
+    /**
+     * The calculated theme object that will be passed through context.
+     */
+    theme: PropTypes.object
+  } : void 0;
+  return {
+    CssVarsProvider,
+    useColorScheme,
+    getInitColorSchemeScript
+  };
+}

package/esm/cssVars/cssVarsParser.js

@@ -0,0 +1,112 @@
+/**
+ * This function create an object from keys, value and then assign to target
+ *
+ * @param {Object} obj : the target object to be assigned
+ * @param {string[]} keys
+ * @param {string | number} value
+ *
+ * @example
+ * const source = {}
+ * assignNestedKeys(source, ['palette', 'primary'], 'var(--palette-primary)')
+ * console.log(source) // { palette: { primary: 'var(--palette-primary)' } }
+ *
+ * @example
+ * const source = { palette: { primary: 'var(--palette-primary)' } }
+ * assignNestedKeys(source, ['palette', 'secondary'], 'var(--palette-secondary)')
+ * console.log(source) // { palette: { primary: 'var(--palette-primary)', secondary: 'var(--palette-secondary)' } }
+ */
+export const assignNestedKeys = (obj, keys, value) => {
+  let temp = obj;
+  keys.forEach((k, index) => {
+    if (index === keys.length - 1) {
+      if (temp && typeof temp === 'object') {
+        temp[k] = value;
+      }
+    } else if (temp && typeof temp === 'object') {
+      if (!temp[k]) {
+        temp[k] = {};
+      }
+
+      temp = temp[k];
+    }
+  });
+};
+/**
+ *
+ * @param {Object} obj : source object
+ * @param {Function} callback : a function that will be called when
+ *                   - the deepest key in source object is reached
+ *                   - the value of the deepest key is NOT `undefined` | `null`
+ *
+ * @example
+ * walkObjectDeep({ palette: { primary: { main: '#000000' } } }, console.log)
+ * // ['palette', 'primary', 'main'] '#000000'
+ */
+
+export const walkObjectDeep = (obj, callback) => {
+  function recurse(object, parentKeys = []) {
+    Object.entries(object).forEach(([key, value]) => {
+      if (value !== undefined && value !== null) {
+        if (typeof value === 'object' && Object.keys(value).length > 0) {
+          recurse(value, [...parentKeys, key]);
+        } else {
+          callback([...parentKeys, key], value);
+        }
+      }
+    });
+  }
+
+  recurse(obj);
+};
+
+const getCssValue = (keys, value) => {
+  if (typeof value === 'number') {
+    if (['lineHeight', 'fontWeight', 'opacity', 'zIndex'].some(prop => keys.includes(prop))) {
+      // css property that are unitless
+      return value;
+    }
+
+    return `${value}px`;
+  }
+
+  return value;
+};
+/**
+ * a function that parse theme and return { css, vars }
+ *
+ * @param {Object} theme
+ * @param {{ prefix?: string }} options
+ * @returns {{ css: Object, vars: Object }} `css` is the stylesheet, `vars` is an object to get css variable (same structure as theme)
+ *
+ * @example
+ * const { css, vars } = parser({
+ *   fontSize: 12,
+ *   lineHeight: 1.2,
+ *   palette: { primary: { 500: '#000000' } }
+ * })
+ *
+ * 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, options) {
+  const {
+    prefix
+  } = 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})`);
+    }
+  });
+  return {
+    css,
+    vars
+  };
+}

package/esm/cssVars/getInitColorSchemeScript.js

@@ -0,0 +1,21 @@
+import * as React from 'react';
+import { jsx as _jsx } from "react/jsx-runtime";
+export const DEFAULT_STORAGE_KEY = 'mui-color-scheme';
+export const DEFAULT_ATTRIBUTE = 'data-mui-color-scheme';
+export default function getInitColorSchemeScript(options) {
+  const {
+    storageKey = DEFAULT_STORAGE_KEY,
+    attribute = DEFAULT_ATTRIBUTE
+  } = options || {};
+  return /*#__PURE__*/_jsx("script", {
+    // eslint-disable-next-line react/no-danger
+    dangerouslySetInnerHTML: {
+      __html: `(function() { try {
+        var colorScheme = localStorage.getItem('${storageKey}');
+        if (colorScheme) {
+          document.body.setAttribute('${attribute}', colorScheme);
+        }
+      } catch (e) {} })();`
+    }
+  });
+}

package/esm/cssVars/index.js

@@ -0,0 +1 @@
+export { default } from './createCssVarsProvider';

package/esm/index.js

@@ -36,4 +36,5 @@ export { default as useThemeProps, getThemeProps } from './useThemeProps';
 export { default as useTheme } from './useTheme';
 export { default as useThemeWithoutDefault } from './useThemeWithoutDefault';
 export * from './colorManipulator';
-export { default as ThemeProvider } from './ThemeProvider';
+export { default as ThemeProvider } from './ThemeProvider';
+export { default as unstable_createCssVarsProvider } from './cssVars/createCssVarsProvider';

package/esm/spacing.js

@@ -39,8 +39,8 @@ const getCssProperties = memoize(prop => {
   const direction = directions[b] || '';
   return Array.isArray(direction) ? direction.map(dir => property + dir) : [property + direction];
 });
-const marginKeys = ['m', 'mt', 'mr', 'mb', 'ml', 'mx', 'my', 'margin', 'marginTop', 'marginRight', 'marginBottom', 'marginLeft', 'marginX', 'marginY'];
-const paddingKeys = ['p', 'pt', 'pr', 'pb', 'pl', 'px', 'py', 'padding', 'paddingTop', 'paddingRight', 'paddingBottom', 'paddingLeft', 'paddingX', 'paddingY'];
+const marginKeys = ['m', 'mt', 'mr', 'mb', 'ml', 'mx', 'my', 'margin', 'marginTop', 'marginRight', 'marginBottom', 'marginLeft', 'marginX', 'marginY', 'marginInline', 'marginInlineStart', 'marginInlineEnd', 'marginBlock', 'marginBlockStart', 'marginBlockEnd'];
+const paddingKeys = ['p', 'pt', 'pr', 'pb', 'pl', 'px', 'py', 'padding', 'paddingTop', 'paddingRight', 'paddingBottom', 'paddingLeft', 'paddingX', 'paddingY', 'paddingInline', 'paddingInlineStart', 'paddingInlineEnd', 'paddingBlock', 'paddingBlockStart', 'paddingBlockEnd'];
 const spacingKeys = [...marginKeys, ...paddingKeys];
 export function createUnaryUnit(theme, themeKey, defaultValue, propName) {
   const themeSpacing = getPath(theme, themeKey) || defaultValue;

package/esm/styleFunctionSx/styleFunctionSx.js

@@ -22,11 +22,11 @@ function styleFunctionSx(props) {
     return null;
   }
 
-  if (typeof styles === 'function') {
-    return styles(theme);
-  }
+  let stylesObject = styles;
 
-  if (typeof styles !== 'object') {
+  if (typeof styles === 'function') {
+    stylesObject = styles(theme);
+  } else if (typeof styles !== 'object') {
     // value
     return styles;
   }
@@ -34,8 +34,8 @@ function styleFunctionSx(props) {
   const emptyBreakpoints = createEmptyBreakpointObject(theme.breakpoints);
   const breakpointsKeys = Object.keys(emptyBreakpoints);
   let css = emptyBreakpoints;
-  Object.keys(styles).forEach(styleKey => {
-    const value = callIfFn(styles[styleKey], theme);
+  Object.keys(stylesObject).forEach(styleKey => {
+    const value = callIfFn(stylesObject[styleKey], theme);
 
     if (typeof value === 'object') {
       if (propToStyleFunction[styleKey]) {

package/flexbox.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.justifySelf = exports.justifyItems = exports.alignSelf = exports.flexShrink = exports.flexGrow = exports.flex = exports.order = exports.alignContent = exports.alignItems = exports.justifyContent = exports.flexWrap = exports.flexDirection = exports.flexBasis = void 0;
+exports.order = exports.justifySelf = exports.justifyItems = exports.justifyContent = exports.flexWrap = exports.flexShrink = exports.flexGrow = exports.flexDirection = exports.flexBasis = exports.flex = exports.default = exports.alignSelf = exports.alignItems = exports.alignContent = void 0;
 
 var _style = _interopRequireDefault(require("./style"));
 

package/getThemeValue.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.propToStyleFunction = void 0;
+exports.propToStyleFunction = exports.default = void 0;
 
 var _borders = _interopRequireDefault(require("./borders"));
 

package/grid.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.gridArea = exports.gridTemplateAreas = exports.gridTemplateRows = exports.gridTemplateColumns = exports.gridAutoRows = exports.gridAutoColumns = exports.gridAutoFlow = exports.gridRow = exports.gridColumn = exports.rowGap = exports.columnGap = exports.gap = void 0;
+exports.rowGap = exports.gridTemplateRows = exports.gridTemplateColumns = exports.gridTemplateAreas = exports.gridRow = exports.gridColumn = exports.gridAutoRows = exports.gridAutoFlow = exports.gridAutoColumns = exports.gridArea = exports.gap = exports.default = exports.columnGap = void 0;
 
 var _style = _interopRequireDefault(require("./style"));
 

package/index.d.ts

@@ -107,6 +107,9 @@ export {
   GlobalStyles,
   GlobalStylesProps,
   StyledEngineProvider,
+  Interpolation,
+  CSSInterpolation,
+  CSSObject,
 } from '@mui/styled-engine';
 
 export * from './style';
@@ -154,3 +157,6 @@ export * from './colorManipulator';
 
 export { default as ThemeProvider } from './ThemeProvider';
 export * from './ThemeProvider';
+
+export { default as unstable_createCssVarsProvider } from './cssVars';
+export * from './cssVars';