@atlaskit/dropdown-menu 11.2.0 → 11.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/dropdown-menu
 
+## 11.2.1
+
+### Patch Changes
+
+- [`347fd703ce0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/347fd703ce0) - Internally shifting to using bind-event-listener for events added in effects
+- [`ce9438bddd0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ce9438bddd0) - Internal TypeScript authoring improvement
+- Updated dependencies
+
 ## 11.2.0
 
 ### Minor Changes

package/dist/cjs/dropdown-menu.js

@@ -19,6 +19,8 @@ var _react = require("react");
 
 var _core = require("@emotion/core");
 
+var _bindEventListener = require("bind-event-listener");
+
 var _standardButton = _interopRequireDefault(require("@atlaskit/button/standard-button"));
 
 var _keycodes = require("@atlaskit/ds-lib/keycodes");
@@ -29,8 +31,6 @@ var _useControlled = _interopRequireDefault(require("@atlaskit/ds-lib/use-contro
 
 var _useFocusEvent = _interopRequireDefault(require("@atlaskit/ds-lib/use-focus-event"));
 
-var _useKeydownEvent = _interopRequireDefault(require("@atlaskit/ds-lib/use-keydown-event"));
-
 var _chevronDown = _interopRequireDefault(require("@atlaskit/icon/glyph/chevron-down"));
 
 var _popup = _interopRequireDefault(require("@atlaskit/popup"));
@@ -108,7 +108,12 @@ var DropdownMenu = function DropdownMenu(props) {
       isTriggeredUsingKeyboard = _useState2[0],
       setTriggeredUsingKeyboard = _useState2[1];
 
-  var handleTriggerClicked = (0, _react.useCallback)(function (event) {
+  var handleTriggerClicked = (0, _react.useCallback)( // TODO: event is an `any` and is being cast incorrectly
+  // This means that the public type for `onOpenChange` is incorrect
+  // current: (event: React.MouseEvent | React.KeyboardEvent) => void;
+  // correct: (event: React.MouseEvent | KeyboardEvent) => void;
+  // https://product-fabric.atlassian.net/browse/DSP-4692
+  function (event) {
     var newValue = !isLocalOpen;
     var clientX = event.clientX,
         clientY = event.clientY,
@@ -138,17 +143,33 @@ var DropdownMenu = function DropdownMenu(props) {
 
   var _useFocus = (0, _useFocusEvent.default)(),
       isFocused = _useFocus.isFocused,
-      bindFocus = _useFocus.bindFocus;
+      bindFocus = _useFocus.bindFocus; // When a trigger is focused, we want to open the dropdown if
+  // the user presses the DownArrow
+
+
+  (0, _react.useEffect)(function () {
+    // Only need to listen for keydown when focused
+    if (!isFocused) {
+      return _noop.default;
+    } // Being safe: we don't want to open the dropdown if it is already open
+    // Note: This shouldn't happen as the trigger should not be able to get focus
 
-  var handleDownArrow = function handleDownArrow(e) {
-    if (e.key === _keycodes.KEY_DOWN) {
-      // prevent page scroll
-      e.preventDefault();
-      handleTriggerClicked(e);
+
+    if (isLocalOpen) {
+      return _noop.default;
     }
-  };
 
-  (0, _useKeydownEvent.default)(handleDownArrow, isFocused);
+    return (0, _bindEventListener.bind)(window, {
+      type: 'keydown',
+      listener: function openOnKeyDown(e) {
+        if (e.key === _keycodes.KEY_DOWN) {
+          // prevent page scroll
+          e.preventDefault();
+          handleTriggerClicked(e);
+        }
+      }
+    });
+  }, [isFocused, isLocalOpen, handleTriggerClicked]);
   var id = (0, _useGeneratedId.default)();
   return (0, _core.jsx)(_selectionStore.default, null, (0, _core.jsx)(_popup.default, {
     id: isLocalOpen ? id : undefined,

package/dist/cjs/internal/components/focus-manager.js

@@ -11,7 +11,9 @@ exports.default = exports.FocusManagerContext = void 0;
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _useKeydownEvent = _interopRequireDefault(require("@atlaskit/ds-lib/use-keydown-event"));
+var _bindEventListener = require("bind-event-listener");
+
+var _noop = _interopRequireDefault(require("@atlaskit/ds-lib/noop"));
 
 var _handleFocus = _interopRequireDefault(require("../utils/handle-focus"));
 
@@ -29,7 +31,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  */
 var FocusManagerContext = /*#__PURE__*/(0, _react.createContext)({
   menuItemRefs: [],
-  registerRef: function registerRef(ref) {}
+  registerRef: _noop.default
 });
 /**
  * Focus manager logic
@@ -44,8 +46,14 @@ var FocusManager = function FocusManager(_ref) {
     if (ref && !menuItemRefs.current.includes(ref)) {
       menuItemRefs.current.push(ref);
     }
-  }, []);
-  (0, _useKeydownEvent.default)((0, _handleFocus.default)(menuItemRefs.current));
+  }, []); // Intentionally rebinding on each render
+
+  (0, _react.useEffect)(function () {
+    return (0, _bindEventListener.bind)(window, {
+      type: 'keydown',
+      listener: (0, _handleFocus.default)(menuItemRefs.current)
+    });
+  });
   var contextValue = {
     menuItemRefs: menuItemRefs.current,
     registerRef: registerRef

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dropdown-menu",
-	"version": "11.2.0",
+	"version": "11.2.1",
 	"sideEffects": false
 }

package/dist/es2019/dropdown-menu.js

@@ -1,14 +1,14 @@
 import _extends from "@babel/runtime/helpers/extends";
 
 /** @jsx jsx */
-import { useCallback, useState } from 'react';
+import { useCallback, useEffect, useState } from 'react';
 import { css, jsx } from '@emotion/core';
+import { bind } from 'bind-event-listener';
 import Button from '@atlaskit/button/standard-button';
 import { KEY_DOWN } from '@atlaskit/ds-lib/keycodes';
 import noop from '@atlaskit/ds-lib/noop';
 import useControlledState from '@atlaskit/ds-lib/use-controlled';
 import useFocus from '@atlaskit/ds-lib/use-focus-event';
-import useKeydownEvent from '@atlaskit/ds-lib/use-keydown-event';
 import ExpandIcon from '@atlaskit/icon/glyph/chevron-down';
 import Popup from '@atlaskit/popup';
 import Spinner from '@atlaskit/spinner';
@@ -54,7 +54,12 @@ const DropdownMenu = props => {
   } = props;
   const [isLocalOpen, setLocalIsOpen] = useControlledState(isOpen, () => defaultOpen);
   const [isTriggeredUsingKeyboard, setTriggeredUsingKeyboard] = useState(false);
-  const handleTriggerClicked = useCallback(event => {
+  const handleTriggerClicked = useCallback( // TODO: event is an `any` and is being cast incorrectly
+  // This means that the public type for `onOpenChange` is incorrect
+  // current: (event: React.MouseEvent | React.KeyboardEvent) => void;
+  // correct: (event: React.MouseEvent | KeyboardEvent) => void;
+  // https://product-fabric.atlassian.net/browse/DSP-4692
+  event => {
     const newValue = !isLocalOpen;
     const {
       clientX,
@@ -86,17 +91,32 @@ const DropdownMenu = props => {
   const {
     isFocused,
     bindFocus
-  } = useFocus();
+  } = useFocus(); // When a trigger is focused, we want to open the dropdown if
+  // the user presses the DownArrow
 
-  const handleDownArrow = e => {
-    if (e.key === KEY_DOWN) {
-      // prevent page scroll
-      e.preventDefault();
-      handleTriggerClicked(e);
+  useEffect(() => {
+    // Only need to listen for keydown when focused
+    if (!isFocused) {
+      return noop;
+    } // Being safe: we don't want to open the dropdown if it is already open
+    // Note: This shouldn't happen as the trigger should not be able to get focus
+
+
+    if (isLocalOpen) {
+      return noop;
     }
-  };
 
-  useKeydownEvent(handleDownArrow, isFocused);
+    return bind(window, {
+      type: 'keydown',
+      listener: function openOnKeyDown(e) {
+        if (e.key === KEY_DOWN) {
+          // prevent page scroll
+          e.preventDefault();
+          handleTriggerClicked(e);
+        }
+      }
+    });
+  }, [isFocused, isLocalOpen, handleTriggerClicked]);
   const id = useGeneratedId();
   return jsx(SelectionStore, null, jsx(Popup, {
     id: isLocalOpen ? id : undefined,

package/dist/es2019/internal/components/focus-manager.js

@@ -1,5 +1,6 @@
-import React, { createContext, useCallback, useRef } from 'react';
-import useKeydownEvent from '@atlaskit/ds-lib/use-keydown-event';
+import React, { createContext, useCallback, useEffect, useRef } from 'react';
+import { bind } from 'bind-event-listener';
+import __noop from '@atlaskit/ds-lib/noop';
 import handleFocus from '../utils/handle-focus';
 /**
  *
@@ -12,7 +13,7 @@ import handleFocus from '../utils/handle-focus';
 
 export const FocusManagerContext = /*#__PURE__*/createContext({
   menuItemRefs: [],
-  registerRef: ref => {}
+  registerRef: __noop
 });
 /**
  * Focus manager logic
@@ -26,8 +27,14 @@ const FocusManager = ({
     if (ref && !menuItemRefs.current.includes(ref)) {
       menuItemRefs.current.push(ref);
     }
-  }, []);
-  useKeydownEvent(handleFocus(menuItemRefs.current));
+  }, []); // Intentionally rebinding on each render
+
+  useEffect(() => {
+    return bind(window, {
+      type: 'keydown',
+      listener: handleFocus(menuItemRefs.current)
+    });
+  });
   const contextValue = {
     menuItemRefs: menuItemRefs.current,
     registerRef

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dropdown-menu",
-	"version": "11.2.0",
+	"version": "11.2.1",
 	"sideEffects": false
 }

package/dist/esm/dropdown-menu.js

@@ -9,14 +9,14 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 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; }
 
 /** @jsx jsx */
-import { useCallback, useState } from 'react';
+import { useCallback, useEffect, useState } from 'react';
 import { css, jsx } from '@emotion/core';
+import { bind } from 'bind-event-listener';
 import Button from '@atlaskit/button/standard-button';
 import { KEY_DOWN } from '@atlaskit/ds-lib/keycodes';
 import noop from '@atlaskit/ds-lib/noop';
 import useControlledState from '@atlaskit/ds-lib/use-controlled';
 import useFocus from '@atlaskit/ds-lib/use-focus-event';
-import useKeydownEvent from '@atlaskit/ds-lib/use-keydown-event';
 import ExpandIcon from '@atlaskit/icon/glyph/chevron-down';
 import Popup from '@atlaskit/popup';
 import Spinner from '@atlaskit/spinner';
@@ -79,7 +79,12 @@ var DropdownMenu = function DropdownMenu(props) {
       isTriggeredUsingKeyboard = _useState2[0],
       setTriggeredUsingKeyboard = _useState2[1];
 
-  var handleTriggerClicked = useCallback(function (event) {
+  var handleTriggerClicked = useCallback( // TODO: event is an `any` and is being cast incorrectly
+  // This means that the public type for `onOpenChange` is incorrect
+  // current: (event: React.MouseEvent | React.KeyboardEvent) => void;
+  // correct: (event: React.MouseEvent | KeyboardEvent) => void;
+  // https://product-fabric.atlassian.net/browse/DSP-4692
+  function (event) {
     var newValue = !isLocalOpen;
     var clientX = event.clientX,
         clientY = event.clientY,
@@ -109,17 +114,33 @@ var DropdownMenu = function DropdownMenu(props) {
 
   var _useFocus = useFocus(),
       isFocused = _useFocus.isFocused,
-      bindFocus = _useFocus.bindFocus;
+      bindFocus = _useFocus.bindFocus; // When a trigger is focused, we want to open the dropdown if
+  // the user presses the DownArrow
 
-  var handleDownArrow = function handleDownArrow(e) {
-    if (e.key === KEY_DOWN) {
-      // prevent page scroll
-      e.preventDefault();
-      handleTriggerClicked(e);
+
+  useEffect(function () {
+    // Only need to listen for keydown when focused
+    if (!isFocused) {
+      return noop;
+    } // Being safe: we don't want to open the dropdown if it is already open
+    // Note: This shouldn't happen as the trigger should not be able to get focus
+
+
+    if (isLocalOpen) {
+      return noop;
     }
-  };
 
-  useKeydownEvent(handleDownArrow, isFocused);
+    return bind(window, {
+      type: 'keydown',
+      listener: function openOnKeyDown(e) {
+        if (e.key === KEY_DOWN) {
+          // prevent page scroll
+          e.preventDefault();
+          handleTriggerClicked(e);
+        }
+      }
+    });
+  }, [isFocused, isLocalOpen, handleTriggerClicked]);
   var id = useGeneratedId();
   return jsx(SelectionStore, null, jsx(Popup, {
     id: isLocalOpen ? id : undefined,

package/dist/esm/internal/components/focus-manager.js

@@ -1,5 +1,6 @@
-import React, { createContext, useCallback, useRef } from 'react';
-import useKeydownEvent from '@atlaskit/ds-lib/use-keydown-event';
+import React, { createContext, useCallback, useEffect, useRef } from 'react';
+import { bind } from 'bind-event-listener';
+import __noop from '@atlaskit/ds-lib/noop';
 import handleFocus from '../utils/handle-focus';
 /**
  *
@@ -12,7 +13,7 @@ import handleFocus from '../utils/handle-focus';
 
 export var FocusManagerContext = /*#__PURE__*/createContext({
   menuItemRefs: [],
-  registerRef: function registerRef(ref) {}
+  registerRef: __noop
 });
 /**
  * Focus manager logic
@@ -25,8 +26,14 @@ var FocusManager = function FocusManager(_ref) {
     if (ref && !menuItemRefs.current.includes(ref)) {
       menuItemRefs.current.push(ref);
     }
-  }, []);
-  useKeydownEvent(handleFocus(menuItemRefs.current));
+  }, []); // Intentionally rebinding on each render
+
+  useEffect(function () {
+    return bind(window, {
+      type: 'keydown',
+      listener: handleFocus(menuItemRefs.current)
+    });
+  });
   var contextValue = {
     menuItemRefs: menuItemRefs.current,
     registerRef: registerRef

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dropdown-menu",
-	"version": "11.2.0",
+	"version": "11.2.1",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/dropdown-menu",
-  "version": "11.2.0",
+  "version": "11.2.1",
   "description": "A dropdown menu displays a list of actions or options to a user.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -18,13 +18,14 @@
     "team": "Design System Team",
     "releaseModel": "scheduled",
     "website": {
-      "name": "Dropdown menu"
+      "name": "Dropdown menu",
+      "category": "Components"
     }
   },
   "dependencies": {
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/codemod-utils": "^4.1.0",
-    "@atlaskit/ds-lib": "^1.4.0",
+    "@atlaskit/ds-lib": "^2.0.0",
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/menu": "^1.3.0",
     "@atlaskit/popup": "^1.3.0",
@@ -33,7 +34,8 @@
     "@atlaskit/tokens": "^0.10.0",
     "@atlaskit/visually-hidden": "^1.0.0",
     "@babel/runtime": "^7.0.0",
-    "@emotion/core": "^10.0.9"
+    "@emotion/core": "^10.0.9",
+    "bind-event-listener": "^2.1.0"
   },
   "peerDependencies": {
     "react": "^16.8.0",
@@ -70,6 +72,7 @@
       "import-structure": "atlassian-conventions"
     },
     "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
       "ui-components": "lite-mode",
       "design-system": "v1",
       "styling": [