@elastic/eui 77.1.1 → 77.1.3

package/es/components/flyout/flyout.js

@@ -255,7 +255,7 @@ export var EuiFlyout = /*#__PURE__*/forwardRef(function (_ref, ref) {
   };
   var flyout = ___EmotionJSX(EuiFocusTrap, _extends({
     disabled: isPushed,
-    scrollLock: ownFocus,
+    scrollLock: hasOverlayMask,
     clickOutsideDisables: !ownFocus,
     onClickOutside: onClickOutside
   }, focusTrapProps), ___EmotionJSX(Element, _extends({

package/es/components/focus_trap/focus_trap.js

@@ -1,4 +1,4 @@
-var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock"];
+var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock", "gapMode"];
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -28,6 +28,7 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
 import React, { Component } from 'react';
 import PropTypes from "prop-types";
 import { FocusOn } from 'react-focus-on';
+import { RemoveScrollBar } from 'react-remove-scroll-bar';
 import { findElementBySelectorOrRef } from '../../services';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 export var EuiFocusTrap = /*#__PURE__*/function (_Component) {
@@ -116,17 +117,25 @@ export var EuiFocusTrap = /*#__PURE__*/function (_Component) {
         returnFocus = _this$props3.returnFocus,
         noIsolation = _this$props3.noIsolation,
         scrollLock = _this$props3.scrollLock,
+        gapMode = _this$props3.gapMode,
         rest = _objectWithoutProperties(_this$props3, _excluded);
       var isDisabled = disabled || this.state.hasBeenDisabledByClick;
       var focusOnProps = _objectSpread(_objectSpread({
         returnFocus: returnFocus,
         noIsolation: noIsolation,
-        scrollLock: scrollLock,
         enabled: !isDisabled
       }, rest), {}, {
-        onClickOutside: this.handleOutsideClick
+        onClickOutside: this.handleOutsideClick,
+        /**
+         * `scrollLock` should always be unset on FocusOn, as it can prevent scrolling on
+         * portals (i.e. popovers, comboboxes, dropdown menus, etc.) within modals & flyouts
+         * @see https://github.com/theKashey/react-focus-on/issues/49
+         */
+        scrollLock: false
       });
-      return ___EmotionJSX(FocusOn, focusOnProps, children);
+      return ___EmotionJSX(FocusOn, focusOnProps, children, !isDisabled && scrollLock && ___EmotionJSX(RemoveScrollBar, {
+        gapMode: gapMode
+      }));
     }
   }]);
   return EuiFocusTrap;
@@ -136,7 +145,8 @@ _defineProperty(EuiFocusTrap, "defaultProps", {
   disabled: false,
   returnFocus: true,
   noIsolation: true,
-  scrollLock: false
+  scrollLock: false,
+  gapMode: 'padding' // EUI defaults to padding because Kibana's body/layout CSS ignores `margin`
 });
 EuiFocusTrap.propTypes = {
   className: PropTypes.string,
@@ -157,5 +167,11 @@ EuiFocusTrap.propTypes = {
      */
   initialFocus: PropTypes.any,
   style: PropTypes.any,
+  /**
+     * if `scrollLock` is set to true, the body's scrollbar width will be preserved on lock
+     * via the `gapMode` CSS property. Depending on your custom CSS, you may prefer to use
+     * `margin` instead of `padding`.
+     */
+  gapMode: PropTypes.oneOf(["padding", "margin"]),
   disabled: PropTypes.bool
 };

package/eui.d.ts

@@ -4261,6 +4261,12 @@ declare module '@elastic/eui/src/components/focus_trap/focus_trap' {
 	     */
 	    initialFocus?: FocusTarget;
 	    style?: CSSProperties;
+	    /**
+	     * if `scrollLock` is set to true, the body's scrollbar width will be preserved on lock
+	     * via the `gapMode` CSS property. Depending on your custom CSS, you may prefer to use
+	     * `margin` instead of `padding`.
+	     */
+	    gapMode?: 'padding' | 'margin';
 	    disabled?: boolean;
 	}
 	export interface EuiFocusTrapProps extends CommonProps, Omit<ReactFocusOnProps, 'enabled'>, // Inverted `disabled` prop used instead
@@ -4276,6 +4282,7 @@ declare module '@elastic/eui/src/components/focus_trap/focus_trap' {
 	        returnFocus: boolean;
 	        noIsolation: boolean;
 	        scrollLock: boolean;
+	        gapMode: string;
 	    };
 	    state: State;
 	    lastInterceptedEvent: Event | null;

package/lib/components/flyout/flyout.js

@@ -260,7 +260,7 @@ var EuiFlyout = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   };
   var flyout = (0, _react2.jsx)(_focus_trap.EuiFocusTrap, _extends({
     disabled: isPushed,
-    scrollLock: ownFocus,
+    scrollLock: hasOverlayMask,
     clickOutsideDisables: !ownFocus,
     onClickOutside: onClickOutside
   }, focusTrapProps), (0, _react2.jsx)(Element, _extends({

package/lib/components/focus_trap/focus_trap.js

@@ -7,9 +7,10 @@ exports.EuiFocusTrap = void 0;
 var _react = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _reactFocusOn = require("react-focus-on");
+var _reactRemoveScrollBar = require("react-remove-scroll-bar");
 var _services = require("../../services");
 var _react2 = require("@emotion/react");
-var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock"];
+var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock", "gapMode"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 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; }
@@ -117,17 +118,25 @@ var EuiFocusTrap = /*#__PURE__*/function (_Component) {
         returnFocus = _this$props3.returnFocus,
         noIsolation = _this$props3.noIsolation,
         scrollLock = _this$props3.scrollLock,
+        gapMode = _this$props3.gapMode,
         rest = _objectWithoutProperties(_this$props3, _excluded);
       var isDisabled = disabled || this.state.hasBeenDisabledByClick;
       var focusOnProps = _objectSpread(_objectSpread({
         returnFocus: returnFocus,
         noIsolation: noIsolation,
-        scrollLock: scrollLock,
         enabled: !isDisabled
       }, rest), {}, {
-        onClickOutside: this.handleOutsideClick
+        onClickOutside: this.handleOutsideClick,
+        /**
+         * `scrollLock` should always be unset on FocusOn, as it can prevent scrolling on
+         * portals (i.e. popovers, comboboxes, dropdown menus, etc.) within modals & flyouts
+         * @see https://github.com/theKashey/react-focus-on/issues/49
+         */
+        scrollLock: false
       });
-      return (0, _react2.jsx)(_reactFocusOn.FocusOn, focusOnProps, children);
+      return (0, _react2.jsx)(_reactFocusOn.FocusOn, focusOnProps, children, !isDisabled && scrollLock && (0, _react2.jsx)(_reactRemoveScrollBar.RemoveScrollBar, {
+        gapMode: gapMode
+      }));
     }
   }]);
   return EuiFocusTrap;
@@ -138,7 +147,8 @@ _defineProperty(EuiFocusTrap, "defaultProps", {
   disabled: false,
   returnFocus: true,
   noIsolation: true,
-  scrollLock: false
+  scrollLock: false,
+  gapMode: 'padding' // EUI defaults to padding because Kibana's body/layout CSS ignores `margin`
 });
 EuiFocusTrap.propTypes = {
   className: _propTypes.default.string,
@@ -159,5 +169,11 @@ EuiFocusTrap.propTypes = {
      */
   initialFocus: _propTypes.default.any,
   style: _propTypes.default.any,
+  /**
+     * if `scrollLock` is set to true, the body's scrollbar width will be preserved on lock
+     * via the `gapMode` CSS property. Depending on your custom CSS, you may prefer to use
+     * `margin` instead of `padding`.
+     */
+  gapMode: _propTypes.default.oneOf(["padding", "margin"]),
   disabled: _propTypes.default.bool
 };

package/optimize/es/components/flyout/flyout.js

@@ -243,7 +243,7 @@ export var EuiFlyout = /*#__PURE__*/forwardRef(function (_ref, ref) {
   };
   var flyout = ___EmotionJSX(EuiFocusTrap, _extends({
     disabled: isPushed,
-    scrollLock: ownFocus,
+    scrollLock: hasOverlayMask,
     clickOutsideDisables: !ownFocus,
     onClickOutside: onClickOutside
   }, focusTrapProps), ___EmotionJSX(Element, _extends({

package/optimize/es/components/focus_trap/focus_trap.js

@@ -6,7 +6,7 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock"];
+var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock", "gapMode"];
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
@@ -21,6 +21,7 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 
 import React, { Component } from 'react';
 import { FocusOn } from 'react-focus-on';
+import { RemoveScrollBar } from 'react-remove-scroll-bar';
 import { findElementBySelectorOrRef } from '../../services';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 export var EuiFocusTrap = /*#__PURE__*/function (_Component) {
@@ -109,17 +110,25 @@ export var EuiFocusTrap = /*#__PURE__*/function (_Component) {
         returnFocus = _this$props3.returnFocus,
         noIsolation = _this$props3.noIsolation,
         scrollLock = _this$props3.scrollLock,
+        gapMode = _this$props3.gapMode,
         rest = _objectWithoutProperties(_this$props3, _excluded);
       var isDisabled = disabled || this.state.hasBeenDisabledByClick;
       var focusOnProps = _objectSpread(_objectSpread({
         returnFocus: returnFocus,
         noIsolation: noIsolation,
-        scrollLock: scrollLock,
         enabled: !isDisabled
       }, rest), {}, {
-        onClickOutside: this.handleOutsideClick
+        onClickOutside: this.handleOutsideClick,
+        /**
+         * `scrollLock` should always be unset on FocusOn, as it can prevent scrolling on
+         * portals (i.e. popovers, comboboxes, dropdown menus, etc.) within modals & flyouts
+         * @see https://github.com/theKashey/react-focus-on/issues/49
+         */
+        scrollLock: false
       });
-      return ___EmotionJSX(FocusOn, focusOnProps, children);
+      return ___EmotionJSX(FocusOn, focusOnProps, children, !isDisabled && scrollLock && ___EmotionJSX(RemoveScrollBar, {
+        gapMode: gapMode
+      }));
     }
   }]);
   return EuiFocusTrap;
@@ -129,5 +138,6 @@ _defineProperty(EuiFocusTrap, "defaultProps", {
   disabled: false,
   returnFocus: true,
   noIsolation: true,
-  scrollLock: false
+  scrollLock: false,
+  gapMode: 'padding' // EUI defaults to padding because Kibana's body/layout CSS ignores `margin`
 });

package/optimize/lib/components/flyout/flyout.js

@@ -249,7 +249,7 @@ var EuiFlyout = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   };
   var flyout = (0, _react2.jsx)(_focus_trap.EuiFocusTrap, (0, _extends2.default)({
     disabled: isPushed,
-    scrollLock: ownFocus,
+    scrollLock: hasOverlayMask,
     clickOutsideDisables: !ownFocus,
     onClickOutside: onClickOutside
   }, focusTrapProps), (0, _react2.jsx)(Element, (0, _extends2.default)({

package/optimize/lib/components/focus_trap/focus_trap.js

@@ -16,9 +16,10 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireWildcard(require("react"));
 var _reactFocusOn = require("react-focus-on");
+var _reactRemoveScrollBar = require("react-remove-scroll-bar");
 var _services = require("../../services");
 var _react2 = require("@emotion/react");
-var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock"];
+var _excluded = ["children", "clickOutsideDisables", "disabled", "returnFocus", "noIsolation", "scrollLock", "gapMode"];
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 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; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -111,17 +112,25 @@ var EuiFocusTrap = /*#__PURE__*/function (_Component) {
         returnFocus = _this$props3.returnFocus,
         noIsolation = _this$props3.noIsolation,
         scrollLock = _this$props3.scrollLock,
+        gapMode = _this$props3.gapMode,
         rest = (0, _objectWithoutProperties2.default)(_this$props3, _excluded);
       var isDisabled = disabled || this.state.hasBeenDisabledByClick;
       var focusOnProps = _objectSpread(_objectSpread({
         returnFocus: returnFocus,
         noIsolation: noIsolation,
-        scrollLock: scrollLock,
         enabled: !isDisabled
       }, rest), {}, {
-        onClickOutside: this.handleOutsideClick
+        onClickOutside: this.handleOutsideClick,
+        /**
+         * `scrollLock` should always be unset on FocusOn, as it can prevent scrolling on
+         * portals (i.e. popovers, comboboxes, dropdown menus, etc.) within modals & flyouts
+         * @see https://github.com/theKashey/react-focus-on/issues/49
+         */
+        scrollLock: false
       });
-      return (0, _react2.jsx)(_reactFocusOn.FocusOn, focusOnProps, children);
+      return (0, _react2.jsx)(_reactFocusOn.FocusOn, focusOnProps, children, !isDisabled && scrollLock && (0, _react2.jsx)(_reactRemoveScrollBar.RemoveScrollBar, {
+        gapMode: gapMode
+      }));
     }
   }]);
   return EuiFocusTrap;
@@ -132,5 +141,6 @@ exports.EuiFocusTrap = EuiFocusTrap;
   disabled: false,
   returnFocus: true,
   noIsolation: true,
-  scrollLock: false
+  scrollLock: false,
+  gapMode: 'padding' // EUI defaults to padding because Kibana's body/layout CSS ignores `margin`
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/eui",
   "description": "Elastic UI Component Library",
-  "version": "77.1.1",
+  "version": "77.1.3",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "lib",
   "module": "es",
@@ -80,6 +80,7 @@
     "react-focus-on": "^3.7.0",
     "react-input-autosize": "^3.0.0",
     "react-is": "^17.0.2",
+    "react-remove-scroll-bar": "^2.3.4",
     "react-virtualized-auto-sizer": "^1.0.6",
     "react-window": "^1.8.6",
     "refractor": "^3.5.0",