@carbon/react 1.23.1 → 1.24.0

package/es/components/ListBox/ListBox.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/ListBoxField.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/ListBoxMenu.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/ListBoxMenuIcon.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/ListBoxMenuItem.d.ts

@@ -16,9 +16,9 @@ export interface ListBoxMenuItemProps extends ReactAttr<HTMLDivElement> {
      */
     isHighlighted?: boolean;
 }
-export type ListBoxMenuItemForwardedRef = ForwardedRef<HTMLDivElement> & {
+export type ListBoxMenuItemForwardedRef = (ForwardedRef<HTMLDivElement> & {
     menuItemOptionRef?: React.Ref<HTMLDivElement>;
-} | null;
+}) | null;
 export type ListBoxMenuItemComponent = ForwardRefReturn<ListBoxMenuItemForwardedRef, ListBoxMenuItemProps>;
 declare const _default: ListBoxMenuItemComponent;
 export default _default;

package/es/components/ListBox/ListBoxMenuItem.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/ListBoxPropTypes.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/ListBoxSelection.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/next/ListBoxSelection.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListBox/next/ListBoxTrigger.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ListItem/ListItem.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/Loading/Loading.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/Loading/index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/Menu/Menu.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -97,10 +97,6 @@ var Menu = /*#__PURE__*/React__default.forwardRef(function Menu(_ref, forwardRef
       returnFocus();
     }
 
-    childDispatch({
-      type: 'clearRegisteredItems'
-    });
-
     if (onClose) {
       onClose();
     }
@@ -204,6 +200,10 @@ var Menu = /*#__PURE__*/React__default.forwardRef(function Menu(_ref, forwardRef
   useEffect(function () {
     if (open) {
       handleOpen();
+    } else {
+      // reset position when menu is closed in order for the --shown
+      // modifier to be applied correctly
+      setPosition(-1, -1);
     } // eslint-disable-next-line react-hooks/exhaustive-deps
 
   }, [open]);

package/es/components/Menu/MenuContext.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -25,12 +25,9 @@ function menuReducer(state, action) {
 
     case 'registerItem':
       return _objectSpread2(_objectSpread2({}, state), {}, {
-        items: [].concat(_toConsumableArray(state.items), [action.payload])
-      });
-
-    case 'clearRegisteredItems':
-      return _objectSpread2(_objectSpread2({}, state), {}, {
-        items: []
+        items: [].concat(_toConsumableArray(state.items), [action.payload]).filter(function (item) {
+          return item.ref.current !== null;
+        })
       });
   }
 }

package/es/components/Menu/MenuItem.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -62,6 +62,8 @@ var MenuItem = /*#__PURE__*/React__default.forwardRef(function MenuItem(_ref, fo
       setSubmenuOpen = _useState4[1];
 
   var hoverIntentTimeout = useRef(null);
+  var isDisabled = disabled && !hasChildren;
+  var isDanger = kind === 'danger' && !hasChildren;
 
   function registerItem() {
     context.dispatch({
@@ -96,13 +98,15 @@ var MenuItem = /*#__PURE__*/React__default.forwardRef(function MenuItem(_ref, fo
   }
 
   function handleClick(e) {
-    if (hasChildren) {
-      openSubmenu();
-    } else {
-      context.state.requestCloseRoot(e);
-
-      if (onClick) {
-        onClick(e);
+    if (!isDisabled) {
+      if (hasChildren) {
+        openSubmenu();
+      } else {
+        context.state.requestCloseRoot(e);
+
+        if (onClick) {
+          onClick(e);
+        }
       }
     }
   }
@@ -133,7 +137,7 @@ var MenuItem = /*#__PURE__*/React__default.forwardRef(function MenuItem(_ref, fo
     }
   }
 
-  var classNames = cx(className, "".concat(prefix, "--menu-item"), (_cx = {}, _defineProperty(_cx, "".concat(prefix, "--menu-item--disabled"), disabled), _defineProperty(_cx, "".concat(prefix, "--menu-item--").concat(kind), kind !== 'default'), _cx)); // on first render, register this menuitem in the context's state
+  var classNames = cx(className, "".concat(prefix, "--menu-item"), (_cx = {}, _defineProperty(_cx, "".concat(prefix, "--menu-item--disabled"), isDisabled), _defineProperty(_cx, "".concat(prefix, "--menu-item--danger"), isDanger), _cx)); // on first render, register this menuitem in the context's state
   // (used for keyboard navigation)
 
   useEffect(function () {
@@ -145,7 +149,7 @@ var MenuItem = /*#__PURE__*/React__default.forwardRef(function MenuItem(_ref, fo
     ref: ref,
     className: classNames,
     tabIndex: "-1",
-    "aria-disabled": disabled,
+    "aria-disabled": isDisabled || null,
     "aria-haspopup": hasChildren || null,
     "aria-expanded": hasChildren ? submenuOpen : null,
     onClick: handleClick,
@@ -226,7 +230,7 @@ var MenuItemSelectable = /*#__PURE__*/React__default.forwardRef(function MenuIte
   var _useControllableState = useControllableState({
     value: selected,
     onChange: onChange,
-    defaultValue: defaultSelected
+    defaultValue: defaultSelected !== null && defaultSelected !== void 0 ? defaultSelected : false
   }),
       _useControllableState2 = _slicedToArray(_useControllableState, 2),
       checked = _useControllableState2[0],

package/es/components/Modal/Modal.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/Modal/index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/ModalWrapper/ModalWrapper.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/MultiSelect/FilterableMultiSelect.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2016, 2022
+ * Copyright IBM Corp. 2016, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.

package/es/components/MultiSelect/MultiSelect.d.ts

@@ -0,0 +1,170 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { UseSelectProps } from 'downshift';
+import React from 'react';
+import { ListBoxSize, ListBoxType } from '../ListBox';
+import { ListBoxProps } from '../ListBox/ListBox';
+import { OnChangeData } from '../Dropdown';
+interface SharedOptions {
+    locale: string;
+}
+interface DownshiftTypedProps<ItemType> {
+    itemToString?(item: ItemType): string;
+}
+interface InternationalProps<MID = string, ARGS = Record<string, unknown>> {
+    translateWithId?(messageId: MID, args?: ARGS): string;
+}
+interface SortItemsOptions<ItemType> extends SharedOptions, DownshiftTypedProps<ItemType> {
+    compareItems(item1: ItemType, item2: ItemType, options: SharedOptions): number;
+    selectedItems: ItemType[];
+}
+interface MultiSelectSortingProps<ItemType> {
+    compareItems?(item1: ItemType, item2: ItemType, options: SharedOptions): number;
+    sortItems?(items: ReadonlyArray<ItemType>, options: SortItemsOptions<ItemType>): ItemType[];
+}
+export interface MultiSelectProps<ItemType> extends MultiSelectSortingProps<ItemType>, InternationalProps<'close.menu' | 'open.menu' | 'clear.all' | 'clear.selection'> {
+    className?: string;
+    /**
+     * Specify the text that should be read for screen readers that describes total items selected
+     */
+    clearSelectionDescription?: string;
+    /**
+     * Specify the text that should be read for screen readers to clear selection.
+     */
+    clearSelectionText?: string;
+    /**
+     * Specify the direction of the multiselect dropdown. Can be either top or bottom.
+     */
+    direction?: 'bottom' | 'top';
+    /**
+     * Disable the control
+     */
+    disabled?: ListBoxProps['disabled'];
+    /**
+     * Additional props passed to Downshift
+     */
+    downshiftProps?: Partial<UseSelectProps<ItemType>>;
+    /**
+     * Provide helper text that is used alongside the control label for
+     * additional help
+     */
+    helperText?: React.ReactNode;
+    /**
+     * Specify whether the title text should be hidden or not
+     */
+    hideLabel?: boolean;
+    /**
+     * Specify a custom `id`
+     */
+    id: string;
+    /**
+     * Allow users to pass in arbitrary items from their collection that are
+     * pre-selected
+     */
+    initialSelectedItems?: ItemType[];
+    /**
+     * Is the current selection invalid?
+     */
+    invalid?: boolean;
+    /**
+     * If invalid, what is the error?
+     */
+    invalidText?: React.ReactNode;
+    /**
+     * Function to render items as custom components instead of strings.
+     * Defaults to null and is overridden by a getter
+     */
+    itemToElement?: React.JSXElementConstructor<ItemType>;
+    /**
+     * Helper function passed to downshift that allows the library to render a
+     * given item to a string label. By default, it extracts the `label` field
+     * from a given item to serve as the item label in the list.
+     */
+    itemToString?(item: ItemType): string;
+    /**
+     * We try to stay as generic as possible here to allow individuals to pass
+     * in a collection of whatever kind of data structure they prefer
+     */
+    items: ItemType[];
+    /**
+     * Generic `label` that will be used as the textual representation of what
+     * this field is for
+     */
+    label: NonNullable<React.ReactNode>;
+    /**
+     * `true` to use the light version.
+     *
+     * @deprecated The `light` prop for `MultiSelect` has
+     *     been deprecated in favor of the new `Layer` component. It will be removed in the next major release.
+     */
+    light?: boolean;
+    /**
+     * Specify the locale of the control. Used for the default `compareItems`
+     * used for sorting the list of items in the control.
+     */
+    locale?: string;
+    /**
+     * `onChange` is a utility for this controlled component to communicate to a
+     * consuming component what kind of internal state changes are occurring.
+     */
+    onChange?(data: OnChangeData<ItemType>): void;
+    /**
+     * `onMenuChange` is a utility for this controlled component to communicate to a
+     * consuming component that the menu was opend(`true`)/closed(`false`).
+     */
+    onMenuChange?(open: boolean): void;
+    /**
+     * Initialize the component with an open(`true`)/closed(`false`) menu.
+     */
+    open?: boolean;
+    /**
+     * Whether or not the Dropdown is readonly
+     */
+    readOnly?: boolean;
+    /**
+     * For full control of the selected items
+     */
+    selectedItems?: ItemType[];
+    /**
+     * Specify feedback (mode) of the selection.
+     * `top`: selected item jumps to top
+     * `fixed`: selected item stays at it's position
+     * `top-after-reopen`: selected item jump to top after reopen dropdown
+     */
+    selectionFeedback?: 'fixed' | 'top' | 'top-after-reopen';
+    /**
+     * Specify the size of the ListBox. Currently supports either `sm`, `md` or `lg` as an option.
+     */
+    size?: ListBoxSize;
+    /**
+     * Provide text to be used in a `<label>` element that is tied to the
+     * multiselect via ARIA attributes.
+     */
+    titleText?: React.ReactNode;
+    /**
+     * Specify 'inline' to create an inline multi-select.
+     */
+    type?: ListBoxType;
+    /**
+     * Specify title to show title on hover
+     */
+    useTitleInItem?: boolean;
+    /**
+     * Specify whether the control is currently in warning state
+     */
+    warn?: boolean;
+    /**
+     * Provide the text that is displayed when the control is in warning state
+     */
+    warnText?: React.ReactNode;
+}
+type MultiSelectComponentProps<ItemType> = React.PropsWithChildren<MultiSelectProps<ItemType>> & React.RefAttributes<HTMLButtonElement>;
+interface MultiSelectComponent {
+    <ItemType>(props: MultiSelectComponentProps<ItemType>): React.ReactElement | null;
+}
+declare const _default: MultiSelectComponent;
+export default _default;