@elastic/eui 100.0.0 → 101.0.1

package/lib/services/theme/high_contrast_overrides.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useHighContrastModifications = void 0;
+var _react = require("react");
+var _euiThemeCommon = require("@elastic/eui-theme-common");
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+// Rather than being calculated when the theme's styles are being computed, we're bogarting the
+// `modify` logic so we can ensure consumer modifications to border-color are also overriden.
+// If in the future we need more complex high contrast mode logic (e.g. changing color tokens)
+// we'll need to actually dive into theme/utils.ts's Computed.getValue logic at that point.
+var useHighContrastModifications = exports.useHighContrastModifications = function useHighContrastModifications(_ref) {
+  var _modifications$border2;
+  var highContrastMode = _ref.highContrastMode,
+    colorMode = _ref.colorMode,
+    system = _ref.system,
+    modifications = _ref.modifications;
+  var highContrastModifications = (0, _react.useMemo)(function () {
+    var borderColor = colorMode === 'DARK' ? system.root.colors.plainLight : system.root.colors.plainDark;
+    var getBorderWidth = function getBorderWidth(width) {
+      var _modifications$border;
+      return (modifications === null || modifications === void 0 || (_modifications$border = modifications.border) === null || _modifications$border === void 0 || (_modifications$border = _modifications$border.width) === null || _modifications$border === void 0 ? void 0 : _modifications$border[width]) || system.root.border.width[width];
+    };
+    var systemTheme = (0, _euiThemeCommon.getComputed)(system, {}, colorMode);
+    var borderColorModifications = {
+      borderBasePrimary: systemTheme.colors.textPrimary,
+      borderBaseAccent: systemTheme.colors.textAccent,
+      borderBaseAccentSecondary: systemTheme.colors.textAccentSecondary,
+      borderBaseSuccess: systemTheme.colors.textSuccess,
+      borderBaseWarning: systemTheme.colors.textWarning,
+      borderBaseDanger: systemTheme.colors.textDanger,
+      borderBasePlain: borderColor,
+      borderBaseSubdued: borderColor,
+      borderBaseDisabled: systemTheme.colors.textDisabled,
+      borderBaseFloating: borderColor,
+      borderBaseFormsControl: borderColor,
+      borderStrongPrimary: systemTheme.colors.textPrimary,
+      borderStrongAccent: systemTheme.colors.textAccent,
+      borderStrongAccentSecondary: systemTheme.colors.textAccentSecondary,
+      borderStrongSuccess: systemTheme.colors.textSuccess,
+      borderStrongWarning: systemTheme.colors.textWarning,
+      borderStrongDanger: systemTheme.colors.textDanger
+    };
+    return {
+      colors: {
+        LIGHT: _objectSpread({}, borderColorModifications),
+        DARK: _objectSpread({}, borderColorModifications)
+      },
+      border: {
+        color: borderColor,
+        thin: "".concat(getBorderWidth('thin'), " solid ").concat(borderColor),
+        thick: "".concat(getBorderWidth('thick'), " solid ").concat(borderColor)
+      }
+    };
+  }, [system, colorMode, modifications === null || modifications === void 0 || (_modifications$border2 = modifications.border) === null || _modifications$border2 === void 0 ? void 0 : _modifications$border2.width]);
+
+  // Memoizing the object(s) returned is important for performance/referential equality
+  return (0, _react.useMemo)(function () {
+    return highContrastMode ? _objectSpread(_objectSpread({}, modifications), highContrastModifications) : modifications;
+  }, [highContrastMode, modifications, highContrastModifications]);
+};

package/lib/services/theme/hooks.js

@@ -27,6 +27,7 @@ var providerMessage = "`EuiProvider` is missing which can result in negative eff
 var useEuiTheme = exports.useEuiTheme = function useEuiTheme() {
   var theme = (0, _react.useContext)(_context.EuiThemeContext);
   var colorMode = (0, _react.useContext)(_context.EuiColorModeContext);
+  var highContrastMode = (0, _react.useContext)(_context.EuiHighContrastModeContext);
   var modifications = (0, _react.useContext)(_context.EuiModificationsContext);
   var isFallback = theme === _context.defaultComputedTheme;
   if (isFallback) {
@@ -36,9 +37,10 @@ var useEuiTheme = exports.useEuiTheme = function useEuiTheme() {
     return {
       euiTheme: theme,
       colorMode: colorMode,
+      highContrastMode: highContrastMode,
       modifications: modifications
     };
-  }, [theme, colorMode, modifications]);
+  }, [theme, colorMode, highContrastMode, modifications]);
   return assembledTheme;
 };
 

package/lib/services/theme/index.js

@@ -21,6 +21,12 @@ Object.defineProperty(exports, "EuiColorModeContext", {
     return _context.EuiColorModeContext;
   }
 });
+Object.defineProperty(exports, "EuiHighContrastModeContext", {
+  enumerable: true,
+  get: function get() {
+    return _context.EuiHighContrastModeContext;
+  }
+});
 Object.defineProperty(exports, "EuiModificationsContext", {
   enumerable: true,
   get: function get() {

package/lib/services/theme/provider.js

@@ -14,6 +14,7 @@ var _current_breakpoint = require("../breakpoint/current_breakpoint");
 var _context = require("./context");
 var _emotion2 = require("./emotion");
 var _style_memoization = require("./style_memoization");
+var _high_contrast_overrides = require("./high_contrast_overrides");
 var _utils = require("./utils");
 var _color = require("../color");
 var _excluded = ["cloneElement", "className"];
@@ -45,6 +46,7 @@ function _arrayWithHoles(r) { if (Array.isArray(r)) return r; } /*
 var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref) {
   var _system = _ref.theme,
     _colorMode = _ref.colorMode,
+    _highContrastMode = _ref.highContrastMode,
     _modifications = _ref.modify,
     children = _ref.children,
     wrapperProps = _ref.wrapperProps;
@@ -56,12 +58,12 @@ var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref
   var parentSystem = (0, _react2.useContext)(_context.EuiSystemContext);
   var parentModifications = (0, _react2.useContext)(_context.EuiModificationsContext);
   var parentColorMode = (0, _react2.useContext)(_context.EuiColorModeContext);
+  var parentHighContrastMode = (0, _react2.useContext)(_context.EuiHighContrastModeContext);
   var parentTheme = (0, _react2.useContext)(_context.EuiThemeContext);
-  var _useState = (0, _react2.useState)(_system || parentSystem),
-    _useState2 = _slicedToArray(_useState, 2),
-    system = _useState2[0],
-    setSystem = _useState2[1];
-  var prevSystemKey = (0, _react2.useRef)(system.key);
+
+  // If the user has an OS-wide high contrast theme applied, it will ignore EUI's
+  // colors and light/dark mode. We should respect the user's system setting
+  var isForced = parentHighContrastMode === 'forced';
 
   // To reduce the number of window resize listeners, only render a
   // CurrentEuiBreakpointProvider for the top level parent theme, or for
@@ -69,23 +71,41 @@ var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref
   var EuiConditionalBreakpointProvider = (0, _react2.useMemo)(function () {
     return isGlobalTheme || _modifications !== null && _modifications !== void 0 && _modifications.breakpoint ? _current_breakpoint.CurrentEuiBreakpointProvider : _react2.Fragment;
   }, [isGlobalTheme, _modifications]);
+  var _useState = (0, _react2.useState)(_system || parentSystem),
+    _useState2 = _slicedToArray(_useState, 2),
+    system = _useState2[0],
+    setSystem = _useState2[1];
+  var prevSystemKey = (0, _react2.useRef)(system.key);
   var _useState3 = (0, _react2.useState)((0, _utils.mergeDeep)(parentModifications, _modifications)),
     _useState4 = _slicedToArray(_useState3, 2),
     modifications = _useState4[0],
     setModifications = _useState4[1];
   var prevModifications = (0, _react2.useRef)(modifications);
-  var _useState5 = (0, _react2.useState)((0, _utils.getColorMode)(_colorMode, parentColorMode)),
+  var _useState5 = (0, _react2.useState)((0, _utils.getColorMode)(_colorMode, parentColorMode, isForced)),
     _useState6 = _slicedToArray(_useState5, 2),
     colorMode = _useState6[0],
     setColorMode = _useState6[1];
   var prevColorMode = (0, _react2.useRef)(colorMode);
-  var isParentTheme = (0, _react2.useRef)(prevSystemKey.current === parentSystem.key && colorMode === parentColorMode && (0, _isEqual.default)(parentModifications, modifications));
+  var highContrastMode = (0, _react2.useMemo)(function () {
+    if (isForced) return 'forced'; // System forced high contrast mode will always supercede application settings
+    if (_highContrastMode === true) return 'preferred'; // Convert the boolean prop to our internal enum
+    if (_highContrastMode === false) return false; // Allow `false` prop to override user/system preference
+    return parentHighContrastMode; // Fall back to the parent/system setting
+  }, [_highContrastMode, parentHighContrastMode, isForced]);
+  var prevHighContrastMode = (0, _react2.useRef)(highContrastMode);
+  var modificationsWithHighContrast = (0, _high_contrast_overrides.useHighContrastModifications)({
+    highContrastMode: highContrastMode,
+    colorMode: colorMode,
+    system: system,
+    modifications: modifications
+  });
+  var isParentTheme = (0, _react2.useRef)(isGlobalTheme ? prevSystemKey.current === _context.DEFAULTS.system.key && colorMode === _context.DEFAULTS.colorMode && highContrastMode === _context.DEFAULTS.highContrastMode && !_modifications : prevSystemKey.current === parentSystem.key && colorMode === parentColorMode && highContrastMode === parentHighContrastMode && (0, _isEqual.default)(parentModifications, modifications));
   var updateVisColorStore = (0, _react2.useCallback)(function (theme) {
     var _theme$flags$hasVisCo, _theme$flags;
     _color.EUI_VIS_COLOR_STORE.setVisColors(theme.colors.vis, (_theme$flags$hasVisCo = (_theme$flags = theme.flags) === null || _theme$flags === void 0 ? void 0 : _theme$flags.hasVisColorAdjustment) !== null && _theme$flags$hasVisCo !== void 0 ? _theme$flags$hasVisCo : true);
   }, []);
   var getInitialTheme = function getInitialTheme() {
-    var theme = (0, _utils.getComputed)(system, (0, _utils.buildTheme)(modifications, "_".concat(system.key)), colorMode);
+    var theme = (0, _utils.getComputed)(system, (0, _utils.buildTheme)(modificationsWithHighContrast, "_".concat(system.key)), colorMode);
     setTimeout(function () {
       updateVisColorStore(theme);
     });
@@ -114,18 +134,23 @@ var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref
     }
   }, [_modifications, parentModifications]);
   (0, _react2.useEffect)(function () {
-    var newColorMode = (0, _utils.getColorMode)(_colorMode, parentColorMode);
+    var newColorMode = (0, _utils.getColorMode)(_colorMode, parentColorMode, isForced);
     if (!(0, _isEqual.default)(newColorMode, prevColorMode.current)) {
       setColorMode(newColorMode);
       prevColorMode.current = newColorMode;
       isParentTheme.current = false;
     }
-  }, [_colorMode, parentColorMode]);
+  }, [_colorMode, parentColorMode, isForced]);
+  (0, _react2.useEffect)(function () {
+    if (prevHighContrastMode.current !== highContrastMode) {
+      isParentTheme.current = false;
+    }
+  }, [highContrastMode]);
   (0, _react2.useEffect)(function () {
     if (!isParentTheme.current) {
-      setTheme((0, _utils.getComputed)(system, (0, _utils.buildTheme)(modifications, "_".concat(system.key)), colorMode));
+      setTheme((0, _utils.getComputed)(system, (0, _utils.buildTheme)(modificationsWithHighContrast, "_".concat(system.key)), colorMode));
     }
-  }, [colorMode, system, modifications]);
+  }, [colorMode, system, modificationsWithHighContrast]);
   var _useState9 = (0, _react2.useState)(),
     _useState10 = _slicedToArray(_useState9, 2),
     themeCSSVariables = _useState10[0],
@@ -139,9 +164,9 @@ var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref
     return {
       isGlobalTheme: false,
       // The theme that determines the global body styles
-      bodyColor: isGlobalTheme ? theme.colors.text : bodyColor,
-      hasDifferentColorFromGlobalTheme: isGlobalTheme ? false : bodyColor !== theme.colors.text,
-      colorClassName: (0, _css2.css)(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n        label: euiColorMode-", ";\n        color: ", ";\n      "])), _colorMode || colorMode, theme.colors.text),
+      bodyColor: isGlobalTheme ? theme.colors.textParagraph : bodyColor,
+      hasDifferentColorFromGlobalTheme: isGlobalTheme ? false : bodyColor !== theme.colors.textParagraph,
+      colorClassName: (0, _css2.css)(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n        label: euiColorMode-", ";\n        color: ", ";\n      "])), _colorMode || colorMode, theme.colors.textParagraph),
       setGlobalCSSVariables: isGlobalTheme ? setThemeCSSVariables : setGlobalCSSVariables,
       globalCSSVariables: isGlobalTheme ? themeCSSVariables : globalCSSVariables,
       setNearestThemeCSSVariables: setThemeCSSVariables,
@@ -182,6 +207,8 @@ var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref
     }, ";label:EuiThemeProvider;")
   }), (0, _react.jsx)(_context.EuiColorModeContext.Provider, {
     value: colorMode
+  }, (0, _react.jsx)(_context.EuiHighContrastModeContext.Provider, {
+    value: highContrastMode
   }, (0, _react.jsx)(_context.EuiSystemContext.Provider, {
     value: system
   }, (0, _react.jsx)(_context.EuiModificationsContext.Provider, {
@@ -190,5 +217,5 @@ var EuiThemeProvider = exports.EuiThemeProvider = function EuiThemeProvider(_ref
     value: theme
   }, (0, _react.jsx)(_context.EuiNestedThemeContext.Provider, {
     value: nestedThemeContext
-  }, (0, _react.jsx)(_style_memoization.EuiThemeMemoizedStylesProvider, null, (0, _react.jsx)(_emotion2.EuiEmotionThemeProvider, null, (0, _react.jsx)(EuiConditionalBreakpointProvider, null, renderedChildren)))))))));
+  }, (0, _react.jsx)(_style_memoization.EuiThemeMemoizedStylesProvider, null, (0, _react.jsx)(_emotion2.EuiEmotionThemeProvider, null, (0, _react.jsx)(EuiConditionalBreakpointProvider, null, renderedChildren))))))))));
 };