@atlaskit/select 20.1.0 → 20.2.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/select
 
+## 20.2.0
+
+### Minor Changes
+
+- [#138461](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/138461)
+  [`455c7f648d71a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/455c7f648d71a) -
+  Internal refactor to PopupSelect behind a feature flag.
+
+  - No longer closing the popup when the internal select menu's onMenuClose is called.
+  - It now registers with the experimental open layer observer, allowing it to close when the
+    observer gives the close signal (e.g. when resizing a page layout slot).
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 20.1.0
 
 ### Minor Changes

package/dist/cjs/PopupSelect/PopupSelect.js

@@ -28,6 +28,7 @@ var _colors = require("@atlaskit/theme/colors");
 var _Select = _interopRequireDefault(require("../Select"));
 var _groupedOptionsAnnouncement = require("../utils/grouped-options-announcement");
 var _components = require("./components");
+var _notifyOpenLayerObserver = require("./notify-open-layer-observer");
 var _excluded = ["footer", "label", "maxMenuWidth", "minMenuWidth", "placeholder", "target", "testId", "onMenuOpen", "onMenuClose"];
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
@@ -452,14 +453,19 @@ var PopupSelect = exports.default = /*#__PURE__*/function (_PureComponent) {
             // Overwriting ariaLiveMessages builtin onFocus method to announce selected option when popup has been opened
             onFocus: onReactSelectFocus
           }, props.ariaLiveMessages)
-          // When the internal select menu closes, we also need to close the popup too.
-          // For example: when the OpenLayerObserver tells the Select menu to close, we also close PopupSelect's popup.
-          ,
-          onMenuClose: (0, _platformFeatureFlags.fg)('platform_dst_layer_observer_select') ? _this.close : undefined
+          // Note: We are intentionally not using `onMenuClose={this.close}` here, due to state management conflicts
+          // between PopupSelect's popup and the internal select menu. This can result in the PopupSelect closing
+          // or opening unexpectedly.
         })), footer));
       });
       return mergedPopperProps.strategy === 'fixed' ? popper : /*#__PURE__*/(0, _reactDom.createPortal)(popper, portalDestination);
     });
+    (0, _defineProperty2.default)(_this, "handleOpenLayerObserverCloseSignal", function () {
+      if (!(0, _platformFeatureFlags.fg)('platform_dst_layer_observer_select')) {
+        return;
+      }
+      _this.close();
+    });
     return _this;
   }
   (0, _inherits2.default)(PopupSelect, _PureComponent);
@@ -526,6 +532,9 @@ var PopupSelect = exports.default = /*#__PURE__*/function (_PureComponent) {
             'aria-controls': isOpen ? id : undefined
           });
         }), _this3.renderSelect(id));
+      }), /*#__PURE__*/_react.default.createElement(_notifyOpenLayerObserver.NotifyOpenLayerObserver, {
+        isOpen: (0, _platformFeatureFlags.fg)('platform_dst_layer_observer_select') && this.state.isOpen,
+        onClose: this.handleOpenLayerObserverCloseSignal
       }));
     }
   }], [{

package/dist/cjs/PopupSelect/notify-open-layer-observer.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NotifyOpenLayerObserver = NotifyOpenLayerObserver;
+var _openLayerObserver = require("@atlaskit/layering/experimental/open-layer-observer");
+/**
+ * Functional component wrapper around `useNotifyOpenLayerObserver`.
+ *
+ * This is needed as PopupSelect is a class component, which cannot use hooks directly.
+ *
+ * Even though the internal `Select` component (used internally by `PopupSelect`) also registers with
+ * the OpenLayerObserver, we are also registering `PopupSelect` as well, to allow the observer to close
+ * the `PopupSelect`'s outer popup.
+ *
+ * This will technically count as 2 open layers, however the specific count is not important - the main
+ * concern is that the observer can know if there are _any_ open layers (0, or 1+), and how to close them.
+ */
+function NotifyOpenLayerObserver(_ref) {
+  var isOpen = _ref.isOpen,
+    onClose = _ref.onClose;
+  (0, _openLayerObserver.useNotifyOpenLayerObserver)({
+    isOpen: isOpen,
+    onClose: onClose
+  });
+  return null;
+}

package/dist/cjs/Select.js

@@ -11,7 +11,7 @@ var _createSelect = _interopRequireDefault(require("./createSelect"));
 /* eslint-disable @repo/internal/react/require-jsdoc */
 
 var packageName = "@atlaskit/select";
-var packageVersion = "20.1.0";
+var packageVersion = "20.2.0";
 var SelectWithoutAnalytics = exports.SelectWithoutAnalytics = (0, _createSelect.default)(_async.default);
 var createAndFireEventOnAtlaskit = (0, _analyticsNext.createAndFireEvent)('atlaskit');
 var Select = (0, _analyticsNext.withAnalyticsContext)({

package/dist/es2019/PopupSelect/PopupSelect.js

@@ -16,6 +16,7 @@ import { N80 } from '@atlaskit/theme/colors';
 import Select from '../Select';
 import { countAllOptions, isOptionsGrouped, onFocus } from '../utils/grouped-options-announcement';
 import { defaultComponents, DummyControl, MenuDialog } from './components';
+import { NotifyOpenLayerObserver } from './notify-open-layer-observer';
 /**
  * Are we rendering on the client or server?
  */
@@ -436,13 +437,18 @@ export default class PopupSelect extends PureComponent {
           onFocus: onReactSelectFocus,
           ...props.ariaLiveMessages // priority to use user handlers if provided
         }
-        // When the internal select menu closes, we also need to close the popup too.
-        // For example: when the OpenLayerObserver tells the Select menu to close, we also close PopupSelect's popup.
-        ,
-        onMenuClose: fg('platform_dst_layer_observer_select') ? this.close : undefined
+        // Note: We are intentionally not using `onMenuClose={this.close}` here, due to state management conflicts
+        // between PopupSelect's popup and the internal select menu. This can result in the PopupSelect closing
+        // or opening unexpectedly.
       })), footer)));
       return mergedPopperProps.strategy === 'fixed' ? popper : /*#__PURE__*/createPortal(popper, portalDestination);
     });
+    _defineProperty(this, "handleOpenLayerObserverCloseSignal", () => {
+      if (!fg('platform_dst_layer_observer_select')) {
+        return;
+      }
+      this.close();
+    });
   }
   static getDerivedStateFromProps(props, state) {
     const newState = {};
@@ -527,7 +533,10 @@ export default class PopupSelect extends PureComponent {
       'aria-haspopup': 'true',
       'aria-expanded': isOpen,
       'aria-controls': isOpen ? id : undefined
-    })), this.renderSelect(id))));
+    })), this.renderSelect(id))), /*#__PURE__*/React.createElement(NotifyOpenLayerObserver, {
+      isOpen: fg('platform_dst_layer_observer_select') && this.state.isOpen,
+      onClose: this.handleOpenLayerObserverCloseSignal
+    }));
   }
 }
 _defineProperty(PopupSelect, "defaultProps", {

package/dist/es2019/PopupSelect/notify-open-layer-observer.js

@@ -0,0 +1,23 @@
+import { useNotifyOpenLayerObserver } from '@atlaskit/layering/experimental/open-layer-observer';
+/**
+ * Functional component wrapper around `useNotifyOpenLayerObserver`.
+ *
+ * This is needed as PopupSelect is a class component, which cannot use hooks directly.
+ *
+ * Even though the internal `Select` component (used internally by `PopupSelect`) also registers with
+ * the OpenLayerObserver, we are also registering `PopupSelect` as well, to allow the observer to close
+ * the `PopupSelect`'s outer popup.
+ *
+ * This will technically count as 2 open layers, however the specific count is not important - the main
+ * concern is that the observer can know if there are _any_ open layers (0, or 1+), and how to close them.
+ */
+export function NotifyOpenLayerObserver({
+  isOpen,
+  onClose
+}) {
+  useNotifyOpenLayerObserver({
+    isOpen,
+    onClose
+  });
+  return null;
+}

package/dist/es2019/Select.js

@@ -3,7 +3,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import AsyncSelect from '@atlaskit/react-select/async';
 import createSelect from './createSelect';
 const packageName = "@atlaskit/select";
-const packageVersion = "20.1.0";
+const packageVersion = "20.2.0";
 export const SelectWithoutAnalytics = createSelect(AsyncSelect);
 const createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
 const Select = withAnalyticsContext({

package/dist/esm/PopupSelect/PopupSelect.js

@@ -27,6 +27,7 @@ import { N80 } from '@atlaskit/theme/colors';
 import Select from '../Select';
 import { countAllOptions, isOptionsGrouped, onFocus } from '../utils/grouped-options-announcement';
 import { defaultComponents, DummyControl, MenuDialog } from './components';
+import { NotifyOpenLayerObserver } from './notify-open-layer-observer';
 /**
  * Are we rendering on the client or server?
  */
@@ -444,14 +445,19 @@ var PopupSelect = /*#__PURE__*/function (_PureComponent) {
             // Overwriting ariaLiveMessages builtin onFocus method to announce selected option when popup has been opened
             onFocus: onReactSelectFocus
           }, props.ariaLiveMessages)
-          // When the internal select menu closes, we also need to close the popup too.
-          // For example: when the OpenLayerObserver tells the Select menu to close, we also close PopupSelect's popup.
-          ,
-          onMenuClose: fg('platform_dst_layer_observer_select') ? _this.close : undefined
+          // Note: We are intentionally not using `onMenuClose={this.close}` here, due to state management conflicts
+          // between PopupSelect's popup and the internal select menu. This can result in the PopupSelect closing
+          // or opening unexpectedly.
         })), footer));
       });
       return mergedPopperProps.strategy === 'fixed' ? popper : /*#__PURE__*/createPortal(popper, portalDestination);
     });
+    _defineProperty(_this, "handleOpenLayerObserverCloseSignal", function () {
+      if (!fg('platform_dst_layer_observer_select')) {
+        return;
+      }
+      _this.close();
+    });
     return _this;
   }
   _inherits(PopupSelect, _PureComponent);
@@ -518,6 +524,9 @@ var PopupSelect = /*#__PURE__*/function (_PureComponent) {
             'aria-controls': isOpen ? id : undefined
           });
         }), _this3.renderSelect(id));
+      }), /*#__PURE__*/React.createElement(NotifyOpenLayerObserver, {
+        isOpen: fg('platform_dst_layer_observer_select') && this.state.isOpen,
+        onClose: this.handleOpenLayerObserverCloseSignal
       }));
     }
   }], [{

package/dist/esm/PopupSelect/notify-open-layer-observer.js

@@ -0,0 +1,22 @@
+import { useNotifyOpenLayerObserver } from '@atlaskit/layering/experimental/open-layer-observer';
+/**
+ * Functional component wrapper around `useNotifyOpenLayerObserver`.
+ *
+ * This is needed as PopupSelect is a class component, which cannot use hooks directly.
+ *
+ * Even though the internal `Select` component (used internally by `PopupSelect`) also registers with
+ * the OpenLayerObserver, we are also registering `PopupSelect` as well, to allow the observer to close
+ * the `PopupSelect`'s outer popup.
+ *
+ * This will technically count as 2 open layers, however the specific count is not important - the main
+ * concern is that the observer can know if there are _any_ open layers (0, or 1+), and how to close them.
+ */
+export function NotifyOpenLayerObserver(_ref) {
+  var isOpen = _ref.isOpen,
+    onClose = _ref.onClose;
+  useNotifyOpenLayerObserver({
+    isOpen: isOpen,
+    onClose: onClose
+  });
+  return null;
+}

package/dist/esm/Select.js

@@ -3,7 +3,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import AsyncSelect from '@atlaskit/react-select/async';
 import createSelect from './createSelect';
 var packageName = "@atlaskit/select";
-var packageVersion = "20.1.0";
+var packageVersion = "20.2.0";
 export var SelectWithoutAnalytics = createSelect(AsyncSelect);
 var createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
 var Select = withAnalyticsContext({

package/dist/types/PopupSelect/PopupSelect.d.ts

@@ -164,6 +164,7 @@ export default class PopupSelect<Option = OptionType, IsMulti extends boolean =
     getMaxHeight: () => number | undefined;
     showSearchControl: () => boolean | undefined;
     renderSelect: (id: string) => React.JSX.Element | null;
+    handleOpenLayerObserverCloseSignal: () => void;
     render(): React.JSX.Element;
 }
 export {};

package/dist/types/PopupSelect/notify-open-layer-observer.d.ts

@@ -0,0 +1,18 @@
+type NotifyOpenLayerObserverProps = {
+    isOpen: boolean;
+    onClose: () => void;
+};
+/**
+ * Functional component wrapper around `useNotifyOpenLayerObserver`.
+ *
+ * This is needed as PopupSelect is a class component, which cannot use hooks directly.
+ *
+ * Even though the internal `Select` component (used internally by `PopupSelect`) also registers with
+ * the OpenLayerObserver, we are also registering `PopupSelect` as well, to allow the observer to close
+ * the `PopupSelect`'s outer popup.
+ *
+ * This will technically count as 2 open layers, however the specific count is not important - the main
+ * concern is that the observer can know if there are _any_ open layers (0, or 1+), and how to close them.
+ */
+export declare function NotifyOpenLayerObserver({ isOpen, onClose }: NotifyOpenLayerObserverProps): null;
+export {};

package/dist/types-ts4.5/PopupSelect/PopupSelect.d.ts

@@ -164,6 +164,7 @@ export default class PopupSelect<Option = OptionType, IsMulti extends boolean =
     getMaxHeight: () => number | undefined;
     showSearchControl: () => boolean | undefined;
     renderSelect: (id: string) => React.JSX.Element | null;
+    handleOpenLayerObserverCloseSignal: () => void;
     render(): React.JSX.Element;
 }
 export {};

package/dist/types-ts4.5/PopupSelect/notify-open-layer-observer.d.ts

@@ -0,0 +1,18 @@
+type NotifyOpenLayerObserverProps = {
+    isOpen: boolean;
+    onClose: () => void;
+};
+/**
+ * Functional component wrapper around `useNotifyOpenLayerObserver`.
+ *
+ * This is needed as PopupSelect is a class component, which cannot use hooks directly.
+ *
+ * Even though the internal `Select` component (used internally by `PopupSelect`) also registers with
+ * the OpenLayerObserver, we are also registering `PopupSelect` as well, to allow the observer to close
+ * the `PopupSelect`'s outer popup.
+ *
+ * This will technically count as 2 open layers, however the specific count is not important - the main
+ * concern is that the observer can know if there are _any_ open layers (0, or 1+), and how to close them.
+ */
+export declare function NotifyOpenLayerObserver({ isOpen, onClose }: NotifyOpenLayerObserverProps): null;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/select",
-	"version": "20.1.0",
+	"version": "20.2.0",
 	"description": "Select allows users to make a single selection or multiple selections from a list of options.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -49,7 +49,7 @@
 		"@atlaskit/react-select": "^2.1.0",
 		"@atlaskit/spinner": "^18.0.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tokens": "^4.6.0",
+		"@atlaskit/tokens": "^4.7.0",
 		"@atlaskit/visually-hidden": "^3.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.3",
@@ -70,7 +70,7 @@
 		"@atlaskit/button": "^23.0.0",
 		"@atlaskit/checkbox": "^17.0.0",
 		"@atlaskit/docs": "^10.0.0",
-		"@atlaskit/drawer": "^10.0.0",
+		"@atlaskit/drawer": "^10.1.0",
 		"@atlaskit/form": "^12.0.0",
 		"@atlaskit/link": "^3.1.0",
 		"@atlaskit/logo": "^16.0.0",