@elastic/eui 114.3.0 → 116.0.0

package/es/components/tool_tip/tool_tip_popover.js

@@ -13,7 +13,7 @@ function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t =
 import React, { useEffect, useRef, useCallback } from 'react';
 import PropTypes from "prop-types";
 import classNames from 'classnames';
-import { useEuiTheme } from '../../services';
+import { useEuiMemoizedStyles } from '../../services';
 import { euiToolTipStyles } from './tool_tip.styles';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 export var EuiToolTipPopover = function EuiToolTipPopover(_ref) {
@@ -24,23 +24,23 @@ export var EuiToolTipPopover = function EuiToolTipPopover(_ref) {
     popoverRef = _ref.popoverRef,
     calculatedPosition = _ref.calculatedPosition,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var popover = useRef();
-  var euiTheme = useEuiTheme();
-  var styles = euiToolTipStyles(euiTheme);
+  var popover = useRef(null);
+  var styles = useEuiMemoizedStyles(euiToolTipStyles);
   var cssStyles = [styles.euiToolTip, calculatedPosition && styles[calculatedPosition]];
   var updateDimensions = useCallback(function () {
     requestAnimationFrame(function () {
-      // Because of this delay, sometimes `positionToolTip` becomes unavailable.
+      // Because of this delay, the popover may have unmounted by the time the RAF fires.
       if (popover.current) {
         positionToolTip();
       }
     });
   }, [positionToolTip]);
-  var setPopoverRef = function setPopoverRef(ref) {
+  var setPopoverRef = useCallback(function (ref) {
+    popover.current = ref;
     if (popoverRef) {
       popoverRef(ref);
     }
-  };
+  }, [popoverRef]);
   useEffect(function () {
     document.body.classList.add('euiBody-hasPortalContent');
     window.addEventListener('resize', updateDimensions);

package/es/global_styling/mixins/_helpers.js

@@ -6,6 +6,7 @@
  * Side Public License, v 1.
  */
 
+import { euiCanAnimate, euiCantAnimate } from '@elastic/eui-theme-common';
 import { useEuiTheme } from '../../services/theme';
 import { transparentize } from '../../services/color';
 import { logicalCSS, logicalCSSWithFallback } from '../functions';
@@ -47,11 +48,15 @@ export var useEuiScrollBar = function useEuiScrollBar(options) {
  * Overflow shadow masks for use in YScroll and XScroll helpers
  */
 
-var euiOverflowShadowStyles = function euiOverflowShadowStyles(_ref3) {
-  var size = _ref3.euiTheme.size;
+export var euiOverflowShadowStyles = function euiOverflowShadowStyles(_ref3) {
+  var _ref3$euiTheme = _ref3.euiTheme,
+    size = _ref3$euiTheme.size,
+    colors = _ref3$euiTheme.colors;
   var _ref4 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
     _direction = _ref4.direction,
-    _side = _ref4.side;
+    _side = _ref4.side,
+    _ref4$hasAnimatedOver = _ref4.hasAnimatedOverflowShadow,
+    hasAnimatedOverflowShadow = _ref4$hasAnimatedOver === void 0 ? false : _ref4$hasAnimatedOver;
   var direction = _direction || 'y';
   var side = _side || 'both';
   var hideHeight = size.s;
@@ -75,11 +80,20 @@ var euiOverflowShadowStyles = function euiOverflowShadowStyles(_ref3) {
   // - https://github.com/elastic/kibana/issues/180828
   // - https://github.com/elastic/eui/pull/6343#issuecomment-1302732021
   var chromiumMaskWorkaround = 'transform: translateZ(0);';
-  if (direction === 'y') {
-    return "mask-image: linear-gradient(to bottom, ".concat(gradient, "); ").concat(chromiumMaskWorkaround);
-  } else {
-    return "mask-image: linear-gradient(to right, ".concat(gradient, "); ").concat(chromiumMaskWorkaround);
+  var overflowShadowStatic = direction === 'y' ? "mask-image: linear-gradient(to bottom, ".concat(gradient, "); ").concat(chromiumMaskWorkaround) : "mask-image: linear-gradient(to right, ".concat(gradient, "); ").concat(chromiumMaskWorkaround);
+
+  // If supported, use the scroll timeline API to animate the gradient to show/hide it on the scroll edges.
+  // We only support vertical scrolling as horizontal scrolling has increased complexity on element dimensions.
+  if (hasAnimatedOverflowShadow && direction === 'y') {
+    var featureFlag = 'animation-timeline: scroll()';
+    var gradientStartColor = "var(--euiOverflowShadowColor, ".concat(colors.backgroundBasePlain, ")");
+    var gradientEndColor = 'transparent';
+    var gradientSize = size.base;
+    var gradientScrollRange = size.m;
+    var commonPseudoElementStyles = "\n      content: '';\n      display: block;\n      position: sticky;\n      z-index: 1;\n      block-size: ".concat(gradientSize, ";\n      pointer-events: none;\n    ");
+    return "\n      @supports not (".concat(featureFlag, ") {\n        ").concat(overflowShadowStatic, "\n      }\n\n      ").concat(euiCantAnimate, " {\n        ").concat(overflowShadowStatic, "\n      }\n\n      ").concat(euiCanAnimate, " {\n        @supports (").concat(featureFlag, ") {\n          @keyframes show { \n            from { opacity: 0 } \n            to { opacity: 1 }\n          }\n          @keyframes hide { \n            from { opacity: 1 }\n            to { opacity: 0 }\n          }\n\n          position: relative;\n\n          /* Gradient on start edge */\n          &::before {\n            ").concat(commonPseudoElementStyles, "\n            inset-block-start: 0;\n            /* prevent pushing down the content */\n            ").concat(logicalCSS('margin-bottom', "-".concat(gradientSize)), " \n            /* uses CSS custom property to support customization depending on layout wrapper background color */\n            background: linear-gradient(to bottom, ").concat(gradientStartColor, ", ").concat(gradientEndColor, ");\n            \n            opacity: 0;\n            animation: show linear both;\n            animation-timeline: scroll(y);\n            animation-range: 0px ").concat(gradientScrollRange, ";\n          }\n\n          /* Gradient on end edge */\n          &::after {\n            ").concat(commonPseudoElementStyles, "\n            inset-block-end: 0;\n            /* prevent adding extra space */\n            ").concat(logicalCSS('margin-top', "-".concat(gradientSize)), " \n            background: linear-gradient(to top, ").concat(gradientStartColor, ", ").concat(gradientEndColor, ");\n\n            \n            /* NOTE: To ensure the bottom gradient is not visible when the container has no overflow,\n            we need to use opacity: 0 as default. Using two animations with 'animation-fill-mode: forwards'\n            ensures the show/hide animation works both with and without overflow. */\n            /* scroll animation */\n            opacity: 0;\n            animation-name: show, hide;\n            animation-timing-function: step-start, linear;\n            animation-fill-mode: forwards;\n            animation-timeline: scroll(y);\n            animation-range: 0% 100%, calc(100% - ").concat(gradientScrollRange, ") 100%;\n          }\n        }\n      }\n    ");
   }
+  return overflowShadowStatic;
 };
 
 /**
@@ -105,20 +119,27 @@ export var euiYScrollWithShadows = function euiYScrollWithShadows(euiTheme) {
   var _ref7 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
     height = _ref7.height,
     _ref7$side = _ref7.side,
-    side = _ref7$side === void 0 ? 'both' : _ref7$side;
+    side = _ref7$side === void 0 ? 'both' : _ref7$side,
+    _ref7$hasAnimatedOver = _ref7.hasAnimatedOverflowShadow,
+    hasAnimatedOverflowShadow = _ref7$hasAnimatedOver === void 0 ? false : _ref7$hasAnimatedOver;
   return "\n  ".concat(euiYScroll(euiTheme, {
     height: height
   }), "\n  ").concat(euiOverflowShadowStyles(euiTheme, {
     direction: 'y',
-    side: side
+    side: side,
+    hasAnimatedOverflowShadow: hasAnimatedOverflowShadow
   }), "\n");
 };
 export var useEuiYScrollWithShadows = function useEuiYScrollWithShadows() {
   var _ref8 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-    height = _ref8.height;
+    height = _ref8.height,
+    side = _ref8.side,
+    hasAnimatedOverflowShadow = _ref8.hasAnimatedOverflowShadow;
   var euiTheme = useEuiTheme();
   return euiYScrollWithShadows(euiTheme, {
-    height: height
+    height: height,
+    side: side,
+    hasAnimatedOverflowShadow: hasAnimatedOverflowShadow
   });
 };
 export var euiXScroll = function euiXScroll(euiTheme) {

package/es/test/rtl/component_helpers.d.ts

@@ -6,9 +6,6 @@
 export declare const waitForEuiPopoverOpen: () => Promise<void>;
 export declare const waitForEuiPopoverClose: () => Promise<void>;
 
-export declare const waitForEuiToolTipVisible: () => Promise<void>;
-export declare const waitForEuiToolTipHidden: () => Promise<void>;
-
 export declare const showEuiComboBoxOptions: () => Promise<void>;
 
 export declare const waitForEuiContextMenuPanelTransition: () => Promise<void>;

package/es/test/rtl/component_helpers.js

@@ -65,81 +65,59 @@ export var waitForEuiPopoverClose = /*#__PURE__*/function () {
 }();
 
 /**
- * Ensure the EuiToolTip being tested is open and visible before continuing
+ * jsdom does not track keyboard vs. mouse input modality, so `:focus-visible`
+ * always returns false. Call this before `fireEvent.focus()` on an element that
+ * should be treated as keyboard-focused.
+ *
+ * Returns a cleanup function, call it after test assertions to restore the spy.
  */
-export var waitForEuiToolTipVisible = /*#__PURE__*/function () {
-  var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
-    return _regeneratorRuntime().wrap(function _callee3$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
-        case 0:
-          _context3.next = 2;
-          return waitFor(function () {
-            var tooltip = document.querySelector('.euiToolTipPopover');
-            expect(tooltip).toBeVisible();
-          }, {
-            timeout: 3000
-          } // Account for long delay on tooltips
-          );
-        case 2:
-          return _context3.abrupt("return", _context3.sent);
-        case 3:
-        case "end":
-          return _context3.stop();
-      }
-    }, _callee3);
-  }));
-  return function waitForEuiToolTipVisible() {
-    return _ref3.apply(this, arguments);
+export var simulateFocusVisible = function simulateFocusVisible(element) {
+  var originalMatches = Element.prototype.matches.bind(element);
+  var spy = jest.spyOn(element, 'matches').mockImplementation(function (selector) {
+    return selector === ':focus-visible' ? true : originalMatches(selector);
+  });
+  return function () {
+    return spy.mockRestore();
   };
-}();
-export var waitForEuiToolTipHidden = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4() {
-    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
-      while (1) switch (_context4.prev = _context4.next) {
-        case 0:
-          _context4.next = 2;
-          return waitFor(function () {
-            var tooltip = document.querySelector('.euiToolTipPopover');
-            expect(tooltip).toBeNull();
-          });
-        case 2:
-          return _context4.abrupt("return", _context4.sent);
-        case 3:
-        case "end":
-          return _context4.stop();
-      }
-    }, _callee4);
-  }));
-  return function waitForEuiToolTipHidden() {
-    return _ref4.apply(this, arguments);
-  };
-}();
+};
+
+/**
+ * Prefer this over `fireEvent.focus()` in tooltip tests. Plain `fireEvent.focus`
+ * does not set `:focus-visible` in jsdom and will not trigger the tooltip.
+ *
+ * Returns a cleanup function to restore the mock after assertions.
+ */
+export var focusEuiToolTipTrigger = function focusEuiToolTipTrigger(element) {
+  var cleanup = simulateFocusVisible(element);
+  fireEvent.focus(element);
+  return cleanup;
+};
 
 /**
  * EuiComboBox
  */
 
 export var showEuiComboBoxOptions = /*#__PURE__*/function () {
-  var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5() {
-    return _regeneratorRuntime().wrap(function _callee5$(_context5) {
-      while (1) switch (_context5.prev = _context5.next) {
+  var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
+    return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
         case 0:
           fireEvent.click(screen.getByTestSubject('comboBoxToggleListButton'));
-          _context5.next = 3;
+          _context3.next = 3;
           return waitForEuiPopoverOpen();
         case 3:
-          _context5.next = 5;
+          _context3.next = 5;
           return waitFor(function () {
             expect(screen.getByRole('listbox')).toBeInTheDocument();
           });
         case 5:
         case "end":
-          return _context5.stop();
+          return _context3.stop();
       }
-    }, _callee5);
+    }, _callee3);
   }));
   return function showEuiComboBoxOptions() {
-    return _ref5.apply(this, arguments);
+    return _ref3.apply(this, arguments);
   };
 }();
 
@@ -148,16 +126,16 @@ export var showEuiComboBoxOptions = /*#__PURE__*/function () {
  */
 
 export var waitForEuiContextMenuPanelTransition = /*#__PURE__*/function () {
-  var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee6() {
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4() {
     var getPanels;
-    return _regeneratorRuntime().wrap(function _callee6$(_context6) {
-      while (1) switch (_context6.prev = _context6.next) {
+    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
         case 0:
           // Used document instead of container or screen due to context menus living in portals
           getPanels = function getPanels() {
             return document.querySelectorAll('.euiContextMenuPanel');
           }; // 2 panels will appear for the transition animation
-          _context6.next = 3;
+          _context4.next = 3;
           return waitFor(function () {
             expect(getPanels().length).toEqual(2);
           });
@@ -172,11 +150,11 @@ export var waitForEuiContextMenuPanelTransition = /*#__PURE__*/function () {
           expect(getPanels().length).toEqual(1);
         case 6:
         case "end":
-          return _context6.stop();
+          return _context4.stop();
       }
-    }, _callee6);
+    }, _callee4);
   }));
   return function waitForEuiContextMenuPanelTransition() {
-    return _ref6.apply(this, arguments);
+    return _ref4.apply(this, arguments);
   };
 }();