@atlaskit/dropdown-menu 11.2.2 → 11.3.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/dropdown-menu
 
+## 11.3.0
+
+### Minor Changes
+
+- [`01d80d395bc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/01d80d395bc) - pass event to onOpenChange consistently
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 11.2.2
 
 ### Patch Changes

package/dist/cjs/dropdown-menu.js

@@ -133,11 +133,12 @@ var DropdownMenu = function DropdownMenu(props) {
       event: event
     });
   }, [onOpenChange, isLocalOpen, setLocalIsOpen]);
-  var handleOnClose = (0, _react.useCallback)(function () {
+  var handleOnClose = (0, _react.useCallback)(function (event) {
     var newValue = false;
     setLocalIsOpen(newValue);
     onOpenChange({
-      isOpen: newValue
+      isOpen: newValue,
+      event: event
     });
   }, [onOpenChange, setLocalIsOpen]);
 

package/dist/cjs/internal/components/menu-wrapper.js

@@ -54,7 +54,7 @@ var MenuWrapper = function MenuWrapper(_ref) {
     // select multiple items.
 
     if (isTargetMenuItemOrDecendant && onClose) {
-      onClose();
+      onClose(e);
     }
   };
 

package/dist/cjs/version.json

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

package/dist/es2019/dropdown-menu.js

@@ -81,11 +81,12 @@ const DropdownMenu = props => {
       event
     });
   }, [onOpenChange, isLocalOpen, setLocalIsOpen]);
-  const handleOnClose = useCallback(() => {
+  const handleOnClose = useCallback(event => {
     const newValue = false;
     setLocalIsOpen(newValue);
     onOpenChange({
-      isOpen: newValue
+      isOpen: newValue,
+      event
     });
   }, [onOpenChange, setLocalIsOpen]);
   const {

package/dist/es2019/internal/components/menu-wrapper.js

@@ -31,7 +31,7 @@ const MenuWrapper = ({
     // select multiple items.
 
     if (isTargetMenuItemOrDecendant && onClose) {
-      onClose();
+      onClose(e);
     }
   };
 

package/dist/es2019/version.json

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

package/dist/esm/dropdown-menu.js

@@ -104,11 +104,12 @@ var DropdownMenu = function DropdownMenu(props) {
       event: event
     });
   }, [onOpenChange, isLocalOpen, setLocalIsOpen]);
-  var handleOnClose = useCallback(function () {
+  var handleOnClose = useCallback(function (event) {
     var newValue = false;
     setLocalIsOpen(newValue);
     onOpenChange({
-      isOpen: newValue
+      isOpen: newValue,
+      event: event
     });
   }, [onOpenChange, setLocalIsOpen]);
 

package/dist/esm/internal/components/menu-wrapper.js

@@ -32,7 +32,7 @@ var MenuWrapper = function MenuWrapper(_ref) {
     // select multiple items.
 
     if (isTargetMenuItemOrDecendant && onClose) {
-      onClose();
+      onClose(e);
     }
   };
 

package/dist/esm/version.json

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

package/dist/esm/visual-regression/index.js

@@ -1,5 +1,5 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { getExampleUrl, loadPage } from '@atlaskit/visual-regression/helper';
 var dropdownTrigger = '[data-testid="dropdown--trigger"]';
 var dropdownContent = '[data-testid="dropdown--content"]';

package/dist/types/types.d.ts

@@ -41,7 +41,7 @@ export interface CustomTriggerProps extends Omit<TriggerProps, 'ref'> {
 }
 export interface OnOpenChangeArgs {
     isOpen: boolean;
-    event?: MouseEvent | KeyboardEvent;
+    event: MouseEvent | KeyboardEvent;
 }
 export interface MenuWrapperProps extends MenuGroupProps {
     setInitialFocusRef?: ContentProps['setInitialFocusRef'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/dropdown-menu",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "A dropdown menu displays a list of actions or options to a user.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,10 +25,10 @@
   "dependencies": {
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/codemod-utils": "^4.1.0",
-    "@atlaskit/ds-lib": "^2.0.0",
+    "@atlaskit/ds-lib": "^2.1.0",
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/menu": "^1.3.0",
-    "@atlaskit/popup": "^1.3.0",
+    "@atlaskit/popup": "^1.4.0",
     "@atlaskit/spinner": "^15.0.0",
     "@atlaskit/theme": "^12.1.0",
     "@atlaskit/tokens": "^0.10.0",

package/report.api.md

@@ -0,0 +1,393 @@
+## API Report File for "@atlaskit/dropdown-menu"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import type { CustomItemProps } from '@atlaskit/menu/types';
+import { default as DropdownItemGroup } from '@atlaskit/menu/section';
+import { KeyboardEvent as KeyboardEvent_2 } from 'react';
+import { MouseEvent as MouseEvent_2 } from 'react';
+import { ReactElement } from 'react';
+import { ReactNode } from 'react';
+import { Ref } from 'react';
+import type { SectionProps } from '@atlaskit/menu';
+import type { SectionProps as SectionProps_2 } from '@atlaskit/menu/types';
+import type { TriggerProps } from '@atlaskit/popup/types';
+
+export declare interface CustomTriggerProps extends Omit<TriggerProps, 'ref'> {
+  /**
+   * Ref that should be applied to the trigger. This is used to calculate the menu position.
+   */
+  triggerRef: Ref<HTMLElement>;
+  /**
+   * Makes the trigger appear selected.
+   */
+  isSelected?: boolean;
+  /**
+   * Event that is triggered when the element is clicked.
+   */
+  onClick?: (e: MouseEvent_2 | KeyboardEvent_2) => void;
+  /**
+   * A `testId` prop is provided for specified elements, which is a unique
+   * string that appears as a data attribute `data-testid` in the rendered code,
+   * serving as a hook for automated tests.
+   *
+   * As dropdown-menu is composed of different components, we passed down the testId to the sub component you want to test:
+   * - `testId--trigger` to get the menu trigger.
+   * - `testId--content` to get the dropdown content trigger.
+   */
+  testId?: string;
+}
+
+/**
+ * __Dropdown menu item__
+ *
+ * A dropdown item populates the dropdown menu with items. Every item should be inside a dropdown item group.
+ *
+ * - [Examples](https://atlassian.design/components/dropdown-item/examples)
+ * - [Code](https://atlassian.design/components/dropdown-item/code)
+ * - [Usage](https://atlassian.design/components/dropdown-item/usage)
+ */
+export declare const DropdownItem: (props: DropdownItemProps) => JSX.Element;
+
+/**
+ * __Dropdown item checkbox__
+ *
+ * A dropdown item checkbox creates groups that have multiple selections.
+ *
+ * - [Examples](https://atlassian.design/components/dropdown-menu/dropdown-item-checkbox/examples)
+ * - [Code](https://atlassian.design/components/dropdown-menu/dropdown-item-checkbox/code)
+ * - [Usage](https://atlassian.design/components/dropdown-menu/dropdown-item-checkbox/usage)
+ */
+export declare const DropdownItemCheckbox: (
+  props: DropdownItemCheckboxProps,
+) => JSX.Element;
+
+/**
+ * __Dropdown item checkbox group__
+ *
+ * A wrapping element for dropdown menu checkbox items.
+ *
+ */
+export declare const DropdownItemCheckboxGroup: (
+  props: DropdownItemCheckboxGroupProps,
+) => JSX.Element;
+
+declare interface DropdownItemCheckboxGroupProps extends SectionProps {
+  /**
+   * Unique identifier for the checkbox group.
+   */
+  id: string;
+}
+
+declare interface DropdownItemCheckboxProps {
+  /**
+   * Primary content for the item.
+   */
+  children: React.ReactNode;
+  /**
+   * Description of the item.
+   * This will render smaller text below the primary text of the item as well as slightly increasing the height of the item.
+   */
+  description?: string | JSX.Element;
+  /**
+   * Makes the checkbox appear disabled as well as removing interactivity.
+   */
+  isDisabled?: boolean;
+  /**
+   * When `true` the title of the item will wrap multiple lines if it's long enough.
+   */
+  shouldTitleWrap?: boolean;
+  /**
+   * When `true` the description of the item will wrap multiple lines if it's long enough.
+   */
+  shouldDescriptionWrap?: boolean;
+  /**
+   * Event that is triggered when the checkbox is clicked.
+   */
+  onClick?: (e: MouseEvent_2 | KeyboardEvent_2) => void;
+  /**
+   * Sets whether the checkbox is checked or unchecked.
+   */
+  isSelected?: boolean;
+  /**
+   * Sets whether the checkbox begins selected.
+   */
+  defaultSelected?: boolean;
+  /**
+   * Unique id of a checkbox
+   */
+  id: string;
+  /**
+   * Adds a title attribute to the root item element.
+   */
+  title?: string;
+  /**
+   * A `testId` prop is provided for specified elements,
+   * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
+   * serving as a hook for automated tests.
+   */
+  testId?: string;
+}
+
+export { DropdownItemGroup };
+
+export declare interface DropdownItemProps {
+  /**
+   * Primary content for the item.
+   */
+  children: React.ReactNode;
+  /**
+   * Custom component to render as an item.
+   */
+  component?: CustomItemProps['component'];
+  /**
+   * Description of the item.
+   * This will render smaller text below the primary text of the item as well as slightly increasing the height of the item.
+   */
+  description?: string | JSX.Element;
+  /**
+   * Makes the element appear disabled as well as removing interactivity.
+   */
+  isDisabled?: boolean;
+  /**
+   * When `true` the title of the item will wrap multiple lines if it's long enough.
+   */
+  shouldTitleWrap?: boolean;
+  /**
+   * When `true` the description of the item will wrap multiple lines if it's long enough.
+   */
+  shouldDescriptionWrap?: boolean;
+  /**
+   * Event that is triggered when the element is clicked.
+   */
+  onClick?: (e: MouseEvent_2 | KeyboardEvent_2) => void;
+  /**
+   * Makes the element appear selected.
+   */
+  isSelected?: boolean;
+  /**
+   * Link to another page.
+   */
+  href?: string;
+  /**
+   * Where to display the linked URL,
+   * see [anchor information](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) on mdn for more information.
+   */
+  target?: string;
+  /**
+   * Adds a title attribute to the root item element.
+   */
+  title?: string;
+  /**
+   * Element to render before the item text.
+   * Generally should be an [icon](https://atlaskit.atlassian.com/packages/design-system/icon) component.
+   */
+  elemBefore?: React.ReactNode;
+  /**
+   * Element to render after the item text.
+   * Generally should be an [icon](https://atlaskit.atlassian.com/packages/design-system/icon) component.
+   */
+  elemAfter?: React.ReactNode;
+  /**
+   * The relationship of the linked URL as space-separated link types.
+   * Generally you'll want to set this to "noopener noreferrer" when `target` is "_blank".
+   */
+  rel?: string;
+  /**
+   * A `testId` prop is provided for specified elements,
+   * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
+   * serving as a hook for automated tests.
+   */
+  testId?: string;
+}
+
+/**
+ * __Dropdown item radio__
+ *
+ * A dropdown item radio displays groups that have a single selection.
+ *
+ * - [Examples](https://atlassian.design/components/dropdown-menu/dropdown-item-radio/examples)
+ * - [Code](https://atlassian.design/components/dropdown-menu/dropdown-item-radio/code)
+ * - [Usage](https://atlassian.design/components/dropdown-menu/dropdown-item-radio/usage)
+ */
+export declare const DropdownItemRadio: (
+  props: DropdownItemRadioProps,
+) => JSX.Element;
+
+/**
+ * __Dropdown item radio group__
+ *  Store which manages the selection state for each DropdownItemRadio
+ *  across mount and unmounts.
+ *
+ */
+export declare const DropdownItemRadioGroup: (
+  props: DropdownItemRadioGroupProps,
+) => JSX.Element;
+
+declare interface DropdownItemRadioGroupProps extends SectionProps {
+  id: string;
+}
+
+declare interface DropdownItemRadioProps {
+  /**
+   * Primary content for the item.
+   */
+  children: React.ReactNode;
+  /**
+   * Description of the item.
+   * This will render smaller text below the primary text of the item as well as slightly increasing the height of the item.
+   */
+  description?: string | JSX.Element;
+  /**
+   * Makes the checkbox appear disabled as well as removing interactivity.
+   */
+  isDisabled?: boolean;
+  /**
+   * When `true` the title of the item will wrap multiple lines if it's long enough.
+   */
+  shouldTitleWrap?: boolean;
+  /**
+   * When `true` the description of the item will wrap multiple lines if it's long enough.
+   */
+  shouldDescriptionWrap?: boolean;
+  /**
+   * Event that is triggered when the checkbox is clicked.
+   */
+  onClick?: (e: MouseEvent_2 | KeyboardEvent_2) => void;
+  /**
+   * Sets whether the checkbox is checked or unchecked.
+   */
+  isSelected?: boolean;
+  /**
+   * Sets whether the checkbox begins selected.
+   */
+  defaultSelected?: boolean;
+  /**
+   * Unique id of a checkbox
+   */
+  id: string;
+  /**
+   * Adds a title attribute to the root item element.
+   */
+  title?: string;
+  /**
+   * A `testId` prop is provided for specified elements,
+   * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
+   * serving as a hook for automated tests.
+   */
+  testId?: string;
+}
+
+/**
+ * __Dropdown menu__
+ *
+ * A dropdown menu displays a list of actions or options to a user.
+ *
+ * - [Examples](https://atlassian.design/components/dropdown-menu/examples)
+ * - [Code](https://atlassian.design/components/dropdown-menu/code)
+ * - [Usage](https://atlassian.design/components/dropdown-menu/usage)
+ */
+declare const DropdownMenu: (props: DropdownMenuProps) => JSX.Element;
+export default DropdownMenu;
+
+export declare interface DropdownMenuGroupProps extends SectionProps_2 {}
+
+export declare interface DropdownMenuProps {
+  /**
+   * Controls the appearance of the menu.
+   * Default menu has scroll after its height exceeds the pre-defined amount.
+   * Tall menu has no scroll until the height exceeds the height of the viewport.
+   */
+  appearance?: 'default' | 'tall';
+  /**
+   * Controls if the first menu item receives focus when menu is opened. Note that the menu has a focus lock
+   * which traps the focus within the menu. Also, the first item gets fouced automatically
+   * if the menu is triggered using the keyboard.
+   *
+   */
+  autoFocus?: boolean;
+  /**
+   * Content that will be rendered inside the layer element. Should typically be
+   * `DropdownItemGroup` or `DropdownItem`, or checkbox / radio variants of those.
+   */
+  children?: ReactNode;
+  /**
+   * If true, a Spinner is rendered instead of the items
+   */
+  isLoading?: boolean;
+  /**
+   * Text to be used as status for assistive technologies. Defaults to "Loading".
+   */
+  statusLabel?: string;
+  /**
+   * Controls the open state of the dropdown.
+   */
+  isOpen?: boolean;
+  /**
+   * Position of the menu.
+   */
+  placement?: Placement;
+  /**
+   * Allows the dropdown menu to be placed on the opposite side of its trigger if it does not
+   * fit in the viewport.
+   */
+  shouldFlip?: boolean;
+  /**
+   * Content which will trigger the dropdown menu to open and close. Use with `triggerType`
+   * to easily get a button trigger.
+   */
+  trigger?: string | ((triggerButtonProps: CustomTriggerProps) => ReactElement);
+  /**
+   * A `testId` prop is provided for specified elements, which is a unique
+   * string that appears as a data attribute `data-testid` in the rendered code,
+   * serving as a hook for automated tests.
+   *
+   * As dropdown-menu is composed of different components, we passed down the testId to the sub component you want to test:
+   * - `testId--trigger` to get the menu trigger.
+   * - `testId--content` to get the dropdown content trigger.
+   */
+  testId?: string;
+  /**
+   * Controls the initial open state of the dropdown. If provided, the component is considered to be controlled
+   * which means that the user is responsible for managing the open and close state of the menu.
+   */
+  defaultOpen?: boolean;
+  /**
+   * Called when the menu should be open/closed. Receives an object with `isOpen` state.
+   */
+  onOpenChange?: (args: OnOpenChangeArgs) => void;
+  /**
+   * Z-index that the popup should be displayed in.
+   * This is passed to the portal component.
+   * Defaults to `layers.modal()` from `@atlaskit/theme` which is 510.
+   */
+  zIndex?: number;
+}
+
+export declare interface OnOpenChangeArgs {
+  isOpen: boolean;
+  event?: MouseEvent_2 | KeyboardEvent_2;
+}
+
+declare type Placement =
+  | 'auto-start'
+  | 'auto'
+  | 'auto-end'
+  | 'top-start'
+  | 'top'
+  | 'top-end'
+  | 'right-start'
+  | 'right'
+  | 'right-end'
+  | 'bottom-end'
+  | 'bottom'
+  | 'bottom-start'
+  | 'left-end'
+  | 'left'
+  | 'left-start';
+
+export {};
+```